naftiko: 1.0.0-alpha2 info: label: NetBox REST API — extras description: 'NetBox REST API — extras. 181 operations. Lead operation: extras. Self-contained Naftiko capability covering one Netbox business surface.' tags: - Netbox - extras created: '2026-05-19' modified: '2026-05-19' binds: - namespace: env keys: NETBOX_API_KEY: NETBOX_API_KEY capability: consumes: - type: http namespace: netbox-extras baseUri: '' description: NetBox REST API — extras business capability. Self-contained, no shared references. resources: - name: api-extras-bookmarks path: /api/extras/bookmarks/ operations: - name: extrasbookmarkslist method: GET description: Get a list of bookmark objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: created in: query type: string - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: object_id in: query type: array - name: object_id__empty in: query type: boolean - name: object_id__gt in: query type: array - name: object_id__gte in: query type: array - name: object_id__lt in: query type: array - name: object_id__lte in: query type: array - name: object_id__n in: query type: array - name: object_type in: query type: array - name: object_type__n in: query type: array - name: object_type_id in: query type: array - name: object_type_id__empty in: query type: array - name: object_type_id__gt in: query type: array - name: object_type_id__gte in: query type: array - name: object_type_id__lt in: query type: array - name: object_type_id__lte in: query type: array - name: object_type_id__n in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: user in: query type: array description: User (name) - name: user__n in: query type: array description: User (name) - name: user_id in: query type: array description: User (ID) - name: user_id__n in: query type: array description: User (ID) - name: extrasbookmarkscreate method: POST description: Post a list of bookmark objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasbookmarksbulkupdate method: PUT description: Put a list of bookmark objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasbookmarksbulkpartialupdate method: PATCH description: Patch a list of bookmark objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasbookmarksbulkdestroy method: DELETE description: Delete a list of bookmark objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-extras-bookmarks-id path: /api/extras/bookmarks/{id}/ operations: - name: extrasbookmarksretrieve method: GET description: Get a bookmark object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this bookmark. required: true - name: extrasbookmarksupdate method: PUT description: Put a bookmark object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this bookmark. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: extrasbookmarkspartialupdate method: PATCH description: Patch a bookmark object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this bookmark. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: extrasbookmarksdestroy method: DELETE description: Delete a bookmark object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this bookmark. required: true - name: api-extras-config-context-profiles path: /api/extras/config-context-profiles/ operations: - name: extrasconfigcontextprofileslist method: GET description: Get a list of config context profile objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: auto_sync_enabled in: query type: boolean - name: created in: query type: array - name: created__empty in: query type: array - name: created__gt in: query type: array - name: created__gte in: query type: array - name: created__lt in: query type: array - name: created__lte in: query type: array - name: created__n in: query type: array - name: created_by_request in: query type: string - name: data_file_id in: query type: array description: Data file (ID) - name: data_file_id__n in: query type: array description: Data file (ID) - name: data_source_id in: query type: array description: Data source (ID) - name: data_source_id__n in: query type: array description: Data source (ID) - name: data_synced in: query type: array - name: data_synced__empty in: query type: boolean - name: data_synced__gt in: query type: array - name: data_synced__gte in: query type: array - name: data_synced__lt in: query type: array - name: data_synced__lte in: query type: array - name: data_synced__n in: query type: array - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: last_updated in: query type: array - name: last_updated__empty in: query type: array - name: last_updated__gt in: query type: array - name: last_updated__gte in: query type: array - name: last_updated__lt in: query type: array - name: last_updated__lte in: query type: array - name: last_updated__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: modified_by_request in: query type: string - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: owner in: query type: array description: Owner (name) - name: owner__n in: query type: array description: Owner (name) - name: owner_group in: query type: array description: Owner Group (name) - name: owner_group__n in: query type: array description: Owner Group (name) - name: owner_group_id in: query type: array description: Owner Group (ID) - name: owner_group_id__n in: query type: array description: Owner Group (ID) - name: owner_id in: query type: array description: Owner (ID) - name: owner_id__n in: query type: array description: Owner (ID) - name: q in: query type: string description: Search - name: tag in: query type: array - name: tag__n in: query type: array - name: tag_id in: query type: array - name: tag_id__n in: query type: array - name: updated_by_request in: query type: string - name: extrasconfigcontextprofilescreate method: POST description: Post a list of config context profile objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasconfigcontextprofilesbulkupdate method: PUT description: Put a list of config context profile objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasconfigcontextprofilesbulkpartialupdate method: PATCH description: Patch a list of config context profile objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasconfigcontextprofilesbulkdestroy method: DELETE description: Delete a list of config context profile objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-extras-config-context-profiles-id path: /api/extras/config-context-profiles/{id}/ operations: - name: extrasconfigcontextprofilesretrieve method: GET description: Get a config context profile object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this config context profile. required: true - name: extrasconfigcontextprofilesupdate method: PUT description: Put a config context profile object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this config context profile. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: extrasconfigcontextprofilespartialupdate method: PATCH description: Patch a config context profile object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this config context profile. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: extrasconfigcontextprofilesdestroy method: DELETE description: Delete a config context profile object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this config context profile. required: true - name: api-extras-config-context-profiles-id-sync path: /api/extras/config-context-profiles/{id}/sync/ operations: - name: extrasconfigcontextprofilessynccreate method: POST description: Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any). outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this config context profile. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: api-extras-config-contexts path: /api/extras/config-contexts/ operations: - name: extrasconfigcontextslist method: GET description: Get a list of config context objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: auto_sync_enabled in: query type: boolean - name: cluster_group in: query type: array description: Cluster group (slug) - name: cluster_group__n in: query type: array description: Cluster group (slug) - name: cluster_group_id in: query type: array description: Cluster group - name: cluster_group_id__n in: query type: array description: Cluster group - name: cluster_id in: query type: array description: Cluster - name: cluster_id__n in: query type: array description: Cluster - name: cluster_type in: query type: array description: Cluster type (slug) - name: cluster_type__n in: query type: array description: Cluster type (slug) - name: cluster_type_id in: query type: array description: Cluster type - name: cluster_type_id__n in: query type: array description: Cluster type - name: created in: query type: array - name: created__empty in: query type: array - name: created__gt in: query type: array - name: created__gte in: query type: array - name: created__lt in: query type: array - name: created__lte in: query type: array - name: created__n in: query type: array - name: created_by_request in: query type: string - name: data_file_id in: query type: array description: Data file (ID) - name: data_file_id__n in: query type: array description: Data file (ID) - name: data_source_id in: query type: array description: Data source (ID) - name: data_source_id__n in: query type: array description: Data source (ID) - name: data_synced in: query type: array - name: data_synced__empty in: query type: boolean - name: data_synced__gt in: query type: array - name: data_synced__gte in: query type: array - name: data_synced__lt in: query type: array - name: data_synced__lte in: query type: array - name: data_synced__n in: query type: array - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: device_role in: query type: array description: Role (slug) - name: device_role__n in: query type: array description: Role (slug) - name: device_role_id in: query type: array description: Role - name: device_role_id__n in: query type: array description: Role - name: device_type_id in: query type: array description: Device type - name: device_type_id__n in: query type: array description: Device type - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: is_active in: query type: boolean - name: last_updated in: query type: array - name: last_updated__empty in: query type: array - name: last_updated__gt in: query type: array - name: last_updated__gte in: query type: array - name: last_updated__lt in: query type: array - name: last_updated__lte in: query type: array - name: last_updated__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: location in: query type: array description: Location (slug) - name: location__n in: query type: array description: Location (slug) - name: location_id in: query type: array description: Location - name: location_id__n in: query type: array description: Location - name: modified_by_request in: query type: string - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: owner in: query type: array description: Owner (name) - name: owner__n in: query type: array description: Owner (name) - name: owner_group in: query type: array description: Owner Group (name) - name: owner_group__n in: query type: array description: Owner Group (name) - name: owner_group_id in: query type: array description: Owner Group (ID) - name: owner_group_id__n in: query type: array description: Owner Group (ID) - name: owner_id in: query type: array description: Owner (ID) - name: owner_id__n in: query type: array description: Owner (ID) - name: platform in: query type: array description: Platform (slug) - name: platform__n in: query type: array description: Platform (slug) - name: platform_id in: query type: array description: Platform - name: platform_id__n in: query type: array description: Platform - name: profile in: query type: array description: Profile (name) - name: profile__n in: query type: array description: Profile (name) - name: profile_id in: query type: array description: Profile (ID) - name: profile_id__n in: query type: array description: Profile (ID) - name: q in: query type: string description: Search - name: region in: query type: array description: Region (slug) - name: region__n in: query type: array description: Region (slug) - name: region_id in: query type: array description: Region - name: region_id__n in: query type: array description: Region - name: site in: query type: array description: Site (slug) - name: site__n in: query type: array description: Site (slug) - name: site_group in: query type: array description: Site group (slug) - name: site_group__n in: query type: array description: Site group (slug) - name: site_group_id in: query type: array description: Site group - name: site_group_id__n in: query type: array description: Site group - name: site_id in: query type: array description: Site - name: site_id__n in: query type: array description: Site - name: tag in: query type: array description: Tag (slug) - name: tag__n in: query type: array description: Tag (slug) - name: tag_id in: query type: array description: Tag - name: tag_id__n in: query type: array description: Tag - name: tenant in: query type: array description: Tenant (slug) - name: tenant__n in: query type: array description: Tenant (slug) - name: tenant_group in: query type: array description: Tenant group (slug) - name: tenant_group__n in: query type: array description: Tenant group (slug) - name: tenant_group_id in: query type: array description: Tenant group - name: tenant_group_id__n in: query type: array description: Tenant group - name: tenant_id in: query type: array description: Tenant - name: tenant_id__n in: query type: array description: Tenant - name: updated_by_request in: query type: string - name: weight in: query type: array - name: weight__empty in: query type: boolean - name: weight__gt in: query type: array - name: weight__gte in: query type: array - name: weight__lt in: query type: array - name: weight__lte in: query type: array - name: weight__n in: query type: array - name: extrasconfigcontextscreate method: POST description: Post a list of config context objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasconfigcontextsbulkupdate method: PUT description: Put a list of config context objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasconfigcontextsbulkpartialupdate method: PATCH description: Patch a list of config context objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasconfigcontextsbulkdestroy method: DELETE description: Delete a list of config context objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-extras-config-contexts-id path: /api/extras/config-contexts/{id}/ operations: - name: extrasconfigcontextsretrieve method: GET description: Get a config context object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this config context. required: true - name: extrasconfigcontextsupdate method: PUT description: Put a config context object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this config context. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: extrasconfigcontextspartialupdate method: PATCH description: Patch a config context object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this config context. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: extrasconfigcontextsdestroy method: DELETE description: Delete a config context object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this config context. required: true - name: api-extras-config-contexts-id-sync path: /api/extras/config-contexts/{id}/sync/ operations: - name: extrasconfigcontextssynccreate method: POST description: Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any). outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this config context. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: api-extras-config-templates path: /api/extras/config-templates/ operations: - name: extrasconfigtemplateslist method: GET description: Get a list of config template objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: as_attachment in: query type: boolean - name: auto_sync_enabled in: query type: boolean - name: created in: query type: array - name: created__empty in: query type: array - name: created__gt in: query type: array - name: created__gte in: query type: array - name: created__lt in: query type: array - name: created__lte in: query type: array - name: created__n in: query type: array - name: created_by_request in: query type: string - name: data_file_id in: query type: array description: Data file (ID) - name: data_file_id__n in: query type: array description: Data file (ID) - name: data_source_id in: query type: array description: Data source (ID) - name: data_source_id__n in: query type: array description: Data source (ID) - name: data_synced in: query type: array - name: data_synced__empty in: query type: boolean - name: data_synced__gt in: query type: array - name: data_synced__gte in: query type: array - name: data_synced__lt in: query type: array - name: data_synced__lte in: query type: array - name: data_synced__n in: query type: array - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: file_extension in: query type: array - name: file_extension__empty in: query type: boolean - name: file_extension__ic in: query type: array - name: file_extension__ie in: query type: array - name: file_extension__iew in: query type: array - name: file_extension__iregex in: query type: array - name: file_extension__isw in: query type: array - name: file_extension__n in: query type: array - name: file_extension__nic in: query type: array - name: file_extension__nie in: query type: array - name: file_extension__niew in: query type: array - name: file_extension__nisw in: query type: array - name: file_extension__regex in: query type: array - name: file_name in: query type: array - name: file_name__empty in: query type: boolean - name: file_name__ic in: query type: array - name: file_name__ie in: query type: array - name: file_name__iew in: query type: array - name: file_name__iregex in: query type: array - name: file_name__isw in: query type: array - name: file_name__n in: query type: array - name: file_name__nic in: query type: array - name: file_name__nie in: query type: array - name: file_name__niew in: query type: array - name: file_name__nisw in: query type: array - name: file_name__regex in: query type: array - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: last_updated in: query type: array - name: last_updated__empty in: query type: array - name: last_updated__gt in: query type: array - name: last_updated__gte in: query type: array - name: last_updated__lt in: query type: array - name: last_updated__lte in: query type: array - name: last_updated__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: mime_type in: query type: array - name: mime_type__empty in: query type: boolean - name: mime_type__ic in: query type: array - name: mime_type__ie in: query type: array - name: mime_type__iew in: query type: array - name: mime_type__iregex in: query type: array - name: mime_type__isw in: query type: array - name: mime_type__n in: query type: array - name: mime_type__nic in: query type: array - name: mime_type__nie in: query type: array - name: mime_type__niew in: query type: array - name: mime_type__nisw in: query type: array - name: mime_type__regex in: query type: array - name: modified_by_request in: query type: string - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: owner in: query type: array description: Owner (name) - name: owner__n in: query type: array description: Owner (name) - name: owner_group in: query type: array description: Owner Group (name) - name: owner_group__n in: query type: array description: Owner Group (name) - name: owner_group_id in: query type: array description: Owner Group (ID) - name: owner_group_id__n in: query type: array description: Owner Group (ID) - name: owner_id in: query type: array description: Owner (ID) - name: owner_id__n in: query type: array description: Owner (ID) - name: q in: query type: string description: Search - name: tag in: query type: array - name: tag__n in: query type: array - name: tag_id in: query type: array - name: tag_id__n in: query type: array - name: updated_by_request in: query type: string - name: extrasconfigtemplatescreate method: POST description: Post a list of config template objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasconfigtemplatesbulkupdate method: PUT description: Put a list of config template objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasconfigtemplatesbulkpartialupdate method: PATCH description: Patch a list of config template objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasconfigtemplatesbulkdestroy method: DELETE description: Delete a list of config template objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-extras-config-templates-id path: /api/extras/config-templates/{id}/ operations: - name: extrasconfigtemplatesretrieve method: GET description: Get a config template object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this config template. required: true - name: extrasconfigtemplatesupdate method: PUT description: Put a config template object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this config template. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: extrasconfigtemplatespartialupdate method: PATCH description: Patch a config template object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this config template. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: extrasconfigtemplatesdestroy method: DELETE description: Delete a config template object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this config template. required: true - name: api-extras-config-templates-id-render path: /api/extras/config-templates/{id}/render/ operations: - name: extrasconfigtemplatesrendercreate method: POST description: Render a ConfigTemplate using the context data provided (if any). If the client requests "text/plain" data, outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: integer description: A unique integer value identifying this config template. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: api-extras-config-templates-id-sync path: /api/extras/config-templates/{id}/sync/ operations: - name: extrasconfigtemplatessynccreate method: POST description: Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any). outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this config template. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: api-extras-custom-field-choice-sets path: /api/extras/custom-field-choice-sets/ operations: - name: extrascustomfieldchoicesetslist method: GET description: Get a list of custom field choice set objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: base_choices in: query type: string description: Base set of predefined choices (optional) - name: base_choices__empty in: query type: boolean - name: base_choices__ic in: query type: array - name: base_choices__ie in: query type: array - name: base_choices__iew in: query type: array - name: base_choices__iregex in: query type: array - name: base_choices__isw in: query type: array - name: base_choices__n in: query type: string description: Base set of predefined choices (optional) - name: base_choices__nic in: query type: array - name: base_choices__nie in: query type: array - name: base_choices__niew in: query type: array - name: base_choices__nisw in: query type: array - name: base_choices__regex in: query type: array - name: choice in: query type: array - name: created in: query type: array - name: created__empty in: query type: array - name: created__gt in: query type: array - name: created__gte in: query type: array - name: created__lt in: query type: array - name: created__lte in: query type: array - name: created__n in: query type: array - name: created_by_request in: query type: string - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: last_updated in: query type: array - name: last_updated__empty in: query type: array - name: last_updated__gt in: query type: array - name: last_updated__gte in: query type: array - name: last_updated__lt in: query type: array - name: last_updated__lte in: query type: array - name: last_updated__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: modified_by_request in: query type: string - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: order_alphabetically in: query type: boolean - name: ordering in: query type: string description: Which field to use when ordering the results. - name: owner in: query type: array description: Owner (name) - name: owner__n in: query type: array description: Owner (name) - name: owner_group in: query type: array description: Owner Group (name) - name: owner_group__n in: query type: array description: Owner Group (name) - name: owner_group_id in: query type: array description: Owner Group (ID) - name: owner_group_id__n in: query type: array description: Owner Group (ID) - name: owner_id in: query type: array description: Owner (ID) - name: owner_id__n in: query type: array description: Owner (ID) - name: q in: query type: string description: Search - name: updated_by_request in: query type: string - name: extrascustomfieldchoicesetscreate method: POST description: Post a list of custom field choice set objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrascustomfieldchoicesetsbulkupdate method: PUT description: Put a list of custom field choice set objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrascustomfieldchoicesetsbulkpartialupdate method: PATCH description: Patch a list of custom field choice set objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrascustomfieldchoicesetsbulkdestroy method: DELETE description: Delete a list of custom field choice set objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-extras-custom-field-choice-sets-id path: /api/extras/custom-field-choice-sets/{id}/ operations: - name: extrascustomfieldchoicesetsretrieve method: GET description: Get a custom field choice set object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this custom field choice set. required: true - name: extrascustomfieldchoicesetsupdate method: PUT description: Put a custom field choice set object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this custom field choice set. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: extrascustomfieldchoicesetspartialupdate method: PATCH description: Patch a custom field choice set object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this custom field choice set. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: extrascustomfieldchoicesetsdestroy method: DELETE description: Delete a custom field choice set object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this custom field choice set. required: true - name: api-extras-custom-field-choice-sets-id-choices path: /api/extras/custom-field-choice-sets/{id}/choices/ operations: - name: extrascustomfieldchoicesetschoicesretrieve method: GET description: Provides an endpoint to iterate through each choice in a set. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this custom field choice set. required: true - name: api-extras-custom-fields path: /api/extras/custom-fields/ operations: - name: extrascustomfieldslist method: GET description: Get a list of custom field objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: choice_set in: query type: array - name: choice_set__n in: query type: array - name: choice_set_id in: query type: array - name: choice_set_id__n in: query type: array - name: created in: query type: array - name: created__empty in: query type: array - name: created__gt in: query type: array - name: created__gte in: query type: array - name: created__lt in: query type: array - name: created__lte in: query type: array - name: created__n in: query type: array - name: created_by_request in: query type: string - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: filter_logic in: query type: string description: Loose matches any instance of a given string; exact matches the entire field. - name: filter_logic__empty in: query type: boolean - name: filter_logic__ic in: query type: array - name: filter_logic__ie in: query type: array - name: filter_logic__iew in: query type: array - name: filter_logic__iregex in: query type: array - name: filter_logic__isw in: query type: array - name: filter_logic__n in: query type: string description: Loose matches any instance of a given string; exact matches the entire field. - name: filter_logic__nic in: query type: array - name: filter_logic__nie in: query type: array - name: filter_logic__niew in: query type: array - name: filter_logic__nisw in: query type: array - name: filter_logic__regex in: query type: array - name: group_name in: query type: array - name: group_name__empty in: query type: boolean - name: group_name__ic in: query type: array - name: group_name__ie in: query type: array - name: group_name__iew in: query type: array - name: group_name__iregex in: query type: array - name: group_name__isw in: query type: array - name: group_name__n in: query type: array - name: group_name__nic in: query type: array - name: group_name__nie in: query type: array - name: group_name__niew in: query type: array - name: group_name__nisw in: query type: array - name: group_name__regex in: query type: array - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: is_cloneable in: query type: boolean - name: label in: query type: array - name: label__empty in: query type: boolean - name: label__ic in: query type: array - name: label__ie in: query type: array - name: label__iew in: query type: array - name: label__iregex in: query type: array - name: label__isw in: query type: array - name: label__n in: query type: array - name: label__nic in: query type: array - name: label__nie in: query type: array - name: label__niew in: query type: array - name: label__nisw in: query type: array - name: label__regex in: query type: array - name: last_updated in: query type: array - name: last_updated__empty in: query type: array - name: last_updated__gt in: query type: array - name: last_updated__gte in: query type: array - name: last_updated__lt in: query type: array - name: last_updated__lte in: query type: array - name: last_updated__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: modified_by_request in: query type: string - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: object_type in: query type: array - name: object_type__ic in: query type: array - name: object_type__ie in: query type: array - name: object_type__iew in: query type: array - name: object_type__iregex in: query type: array - name: object_type__isw in: query type: array - name: object_type__n in: query type: array - name: object_type__nic in: query type: array - name: object_type__nie in: query type: array - name: object_type__niew in: query type: array - name: object_type__nisw in: query type: array - name: object_type__regex in: query type: array - name: object_type_id in: query type: array - name: object_type_id__n in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: owner in: query type: array description: Owner (name) - name: owner__n in: query type: array description: Owner (name) - name: owner_group in: query type: array description: Owner Group (name) - name: owner_group__n in: query type: array description: Owner Group (name) - name: owner_group_id in: query type: array description: Owner Group (ID) - name: owner_group_id__n in: query type: array description: Owner Group (ID) - name: owner_id in: query type: array description: Owner (ID) - name: owner_id__n in: query type: array description: Owner (ID) - name: q in: query type: string description: Search - name: related_object_type in: query type: array - name: related_object_type__n in: query type: array - name: related_object_type_id in: query type: array - name: related_object_type_id__n in: query type: array - name: required in: query type: boolean - name: search_weight in: query type: array - name: search_weight__empty in: query type: boolean - name: search_weight__gt in: query type: array - name: search_weight__gte in: query type: array - name: search_weight__lt in: query type: array - name: search_weight__lte in: query type: array - name: search_weight__n in: query type: array - name: type in: query type: array description: The type of data this custom field holds - name: type__empty in: query type: boolean - name: type__ic in: query type: array description: The type of data this custom field holds - name: type__ie in: query type: array description: The type of data this custom field holds - name: type__iew in: query type: array description: The type of data this custom field holds - name: type__iregex in: query type: array description: The type of data this custom field holds - name: type__isw in: query type: array description: The type of data this custom field holds - name: type__n in: query type: array description: The type of data this custom field holds - name: type__nic in: query type: array description: The type of data this custom field holds - name: type__nie in: query type: array description: The type of data this custom field holds - name: type__niew in: query type: array description: The type of data this custom field holds - name: type__nisw in: query type: array description: The type of data this custom field holds - name: type__regex in: query type: array description: The type of data this custom field holds - name: ui_editable in: query type: string description: Specifies whether the custom field value can be edited in the UI - name: ui_editable__empty in: query type: boolean - name: ui_editable__ic in: query type: array - name: ui_editable__ie in: query type: array - name: ui_editable__iew in: query type: array - name: ui_editable__iregex in: query type: array - name: ui_editable__isw in: query type: array - name: ui_editable__n in: query type: string description: Specifies whether the custom field value can be edited in the UI - name: ui_editable__nic in: query type: array - name: ui_editable__nie in: query type: array - name: ui_editable__niew in: query type: array - name: ui_editable__nisw in: query type: array - name: ui_editable__regex in: query type: array - name: ui_visible in: query type: string description: Specifies whether the custom field is displayed in the UI - name: ui_visible__empty in: query type: boolean - name: ui_visible__ic in: query type: array - name: ui_visible__ie in: query type: array - name: ui_visible__iew in: query type: array - name: ui_visible__iregex in: query type: array - name: ui_visible__isw in: query type: array - name: ui_visible__n in: query type: string description: Specifies whether the custom field is displayed in the UI - name: ui_visible__nic in: query type: array - name: ui_visible__nie in: query type: array - name: ui_visible__niew in: query type: array - name: ui_visible__nisw in: query type: array - name: ui_visible__regex in: query type: array - name: unique in: query type: boolean - name: updated_by_request in: query type: string - name: validation_maximum in: query type: array - name: validation_maximum__empty in: query type: boolean - name: validation_maximum__gt in: query type: array - name: validation_maximum__gte in: query type: array - name: validation_maximum__lt in: query type: array - name: validation_maximum__lte in: query type: array - name: validation_maximum__n in: query type: array - name: validation_minimum in: query type: array - name: validation_minimum__empty in: query type: boolean - name: validation_minimum__gt in: query type: array - name: validation_minimum__gte in: query type: array - name: validation_minimum__lt in: query type: array - name: validation_minimum__lte in: query type: array - name: validation_minimum__n in: query type: array - name: validation_regex in: query type: array - name: validation_regex__empty in: query type: boolean - name: validation_regex__ic in: query type: array - name: validation_regex__ie in: query type: array - name: validation_regex__iew in: query type: array - name: validation_regex__iregex in: query type: array - name: validation_regex__isw in: query type: array - name: validation_regex__n in: query type: array - name: validation_regex__nic in: query type: array - name: validation_regex__nie in: query type: array - name: validation_regex__niew in: query type: array - name: validation_regex__nisw in: query type: array - name: validation_regex__regex in: query type: array - name: weight in: query type: array - name: weight__empty in: query type: boolean - name: weight__gt in: query type: array - name: weight__gte in: query type: array - name: weight__lt in: query type: array - name: weight__lte in: query type: array - name: weight__n in: query type: array - name: extrascustomfieldscreate method: POST description: Post a list of custom field objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrascustomfieldsbulkupdate method: PUT description: Put a list of custom field objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrascustomfieldsbulkpartialupdate method: PATCH description: Patch a list of custom field objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrascustomfieldsbulkdestroy method: DELETE description: Delete a list of custom field objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-extras-custom-fields-id path: /api/extras/custom-fields/{id}/ operations: - name: extrascustomfieldsretrieve method: GET description: Get a custom field object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this custom field. required: true - name: extrascustomfieldsupdate method: PUT description: Put a custom field object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this custom field. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: extrascustomfieldspartialupdate method: PATCH description: Patch a custom field object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this custom field. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: extrascustomfieldsdestroy method: DELETE description: Delete a custom field object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this custom field. required: true - name: api-extras-custom-links path: /api/extras/custom-links/ operations: - name: extrascustomlinkslist method: GET description: Get a list of custom link objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: button_class in: query type: string description: The class of the first link in a group will be used for the dropdown button - name: button_class__empty in: query type: boolean - name: button_class__ic in: query type: array - name: button_class__ie in: query type: array - name: button_class__iew in: query type: array - name: button_class__iregex in: query type: array - name: button_class__isw in: query type: array - name: button_class__n in: query type: string description: The class of the first link in a group will be used for the dropdown button - name: button_class__nic in: query type: array - name: button_class__nie in: query type: array - name: button_class__niew in: query type: array - name: button_class__nisw in: query type: array - name: button_class__regex in: query type: array - name: created in: query type: array - name: created__empty in: query type: array - name: created__gt in: query type: array - name: created__gte in: query type: array - name: created__lt in: query type: array - name: created__lte in: query type: array - name: created__n in: query type: array - name: created_by_request in: query type: string - name: enabled in: query type: boolean - name: group_name in: query type: array - name: group_name__empty in: query type: boolean - name: group_name__ic in: query type: array - name: group_name__ie in: query type: array - name: group_name__iew in: query type: array - name: group_name__iregex in: query type: array - name: group_name__isw in: query type: array - name: group_name__n in: query type: array - name: group_name__nic in: query type: array - name: group_name__nie in: query type: array - name: group_name__niew in: query type: array - name: group_name__nisw in: query type: array - name: group_name__regex in: query type: array - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: last_updated in: query type: array - name: last_updated__empty in: query type: array - name: last_updated__gt in: query type: array - name: last_updated__gte in: query type: array - name: last_updated__lt in: query type: array - name: last_updated__lte in: query type: array - name: last_updated__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: link_text in: query type: string - name: link_text__ic in: query type: string - name: link_text__ie in: query type: string - name: link_text__iew in: query type: string - name: link_text__iregex in: query type: string - name: link_text__isw in: query type: string - name: link_text__n in: query type: string - name: link_text__nic in: query type: string - name: link_text__nie in: query type: string - name: link_text__niew in: query type: string - name: link_text__nisw in: query type: string - name: link_text__regex in: query type: string - name: link_url in: query type: string - name: link_url__ic in: query type: string - name: link_url__ie in: query type: string - name: link_url__iew in: query type: string - name: link_url__iregex in: query type: string - name: link_url__isw in: query type: string - name: link_url__n in: query type: string - name: link_url__nic in: query type: string - name: link_url__nie in: query type: string - name: link_url__niew in: query type: string - name: link_url__nisw in: query type: string - name: link_url__regex in: query type: string - name: modified_by_request in: query type: string - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: new_window in: query type: boolean - name: object_type in: query type: array - name: object_type__ic in: query type: array - name: object_type__ie in: query type: array - name: object_type__iew in: query type: array - name: object_type__iregex in: query type: array - name: object_type__isw in: query type: array - name: object_type__n in: query type: array - name: object_type__nic in: query type: array - name: object_type__nie in: query type: array - name: object_type__niew in: query type: array - name: object_type__nisw in: query type: array - name: object_type__regex in: query type: array - name: object_type_id in: query type: array - name: object_type_id__n in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: owner in: query type: array description: Owner (name) - name: owner__n in: query type: array description: Owner (name) - name: owner_group in: query type: array description: Owner Group (name) - name: owner_group__n in: query type: array description: Owner Group (name) - name: owner_group_id in: query type: array description: Owner Group (ID) - name: owner_group_id__n in: query type: array description: Owner Group (ID) - name: owner_id in: query type: array description: Owner (ID) - name: owner_id__n in: query type: array description: Owner (ID) - name: q in: query type: string description: Search - name: updated_by_request in: query type: string - name: weight in: query type: array - name: weight__empty in: query type: boolean - name: weight__gt in: query type: array - name: weight__gte in: query type: array - name: weight__lt in: query type: array - name: weight__lte in: query type: array - name: weight__n in: query type: array - name: extrascustomlinkscreate method: POST description: Post a list of custom link objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrascustomlinksbulkupdate method: PUT description: Put a list of custom link objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrascustomlinksbulkpartialupdate method: PATCH description: Patch a list of custom link objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrascustomlinksbulkdestroy method: DELETE description: Delete a list of custom link objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-extras-custom-links-id path: /api/extras/custom-links/{id}/ operations: - name: extrascustomlinksretrieve method: GET description: Get a custom link object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this custom link. required: true - name: extrascustomlinksupdate method: PUT description: Put a custom link object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this custom link. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: extrascustomlinkspartialupdate method: PATCH description: Patch a custom link object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this custom link. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: extrascustomlinksdestroy method: DELETE description: Delete a custom link object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this custom link. required: true - name: api-extras-dashboard path: /api/extras/dashboard/ operations: - name: extrasdashboardretrieve method: GET description: Get a list of dashboard objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: extrasdashboardupdate method: PUT description: Put a list of dashboard objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: extrasdashboardpartialupdate method: PATCH description: Patch a list of dashboard objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: extrasdashboarddestroy method: DELETE description: Delete a list of dashboard objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-extras-event-rules path: /api/extras/event-rules/ operations: - name: extraseventruleslist method: GET description: Get a list of event rule objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: action_object_id in: query type: array - name: action_object_id__empty in: query type: array - name: action_object_id__gt in: query type: array - name: action_object_id__gte in: query type: array - name: action_object_id__lt in: query type: array - name: action_object_id__lte in: query type: array - name: action_object_id__n in: query type: array - name: action_object_type in: query type: array - name: action_object_type__n in: query type: array - name: action_type in: query type: array - name: action_type__empty in: query type: boolean - name: action_type__ic in: query type: array - name: action_type__ie in: query type: array - name: action_type__iew in: query type: array - name: action_type__iregex in: query type: array - name: action_type__isw in: query type: array - name: action_type__n in: query type: array - name: action_type__nic in: query type: array - name: action_type__nie in: query type: array - name: action_type__niew in: query type: array - name: action_type__nisw in: query type: array - name: action_type__regex in: query type: array - name: created in: query type: array - name: created__empty in: query type: array - name: created__gt in: query type: array - name: created__gte in: query type: array - name: created__lt in: query type: array - name: created__lte in: query type: array - name: created__n in: query type: array - name: created_by_request in: query type: string - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: enabled in: query type: boolean - name: event_type in: query type: array - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: last_updated in: query type: array - name: last_updated__empty in: query type: array - name: last_updated__gt in: query type: array - name: last_updated__gte in: query type: array - name: last_updated__lt in: query type: array - name: last_updated__lte in: query type: array - name: last_updated__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: modified_by_request in: query type: string - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: object_type in: query type: array - name: object_type__ic in: query type: array - name: object_type__ie in: query type: array - name: object_type__iew in: query type: array - name: object_type__iregex in: query type: array - name: object_type__isw in: query type: array - name: object_type__n in: query type: array - name: object_type__nic in: query type: array - name: object_type__nie in: query type: array - name: object_type__niew in: query type: array - name: object_type__nisw in: query type: array - name: object_type__regex in: query type: array - name: object_type_id in: query type: array - name: object_type_id__n in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: owner in: query type: array description: Owner (name) - name: owner__n in: query type: array description: Owner (name) - name: owner_group in: query type: array description: Owner Group (name) - name: owner_group__n in: query type: array description: Owner Group (name) - name: owner_group_id in: query type: array description: Owner Group (ID) - name: owner_group_id__n in: query type: array description: Owner Group (ID) - name: owner_id in: query type: array description: Owner (ID) - name: owner_id__n in: query type: array description: Owner (ID) - name: q in: query type: string description: Search - name: tag in: query type: array - name: tag__n in: query type: array - name: tag_id in: query type: array - name: tag_id__n in: query type: array - name: updated_by_request in: query type: string - name: extraseventrulescreate method: POST description: Post a list of event rule objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extraseventrulesbulkupdate method: PUT description: Put a list of event rule objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extraseventrulesbulkpartialupdate method: PATCH description: Patch a list of event rule objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extraseventrulesbulkdestroy method: DELETE description: Delete a list of event rule objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-extras-event-rules-id path: /api/extras/event-rules/{id}/ operations: - name: extraseventrulesretrieve method: GET description: Get a event rule object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this event rule. required: true - name: extraseventrulesupdate method: PUT description: Put a event rule object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this event rule. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: extraseventrulespartialupdate method: PATCH description: Patch a event rule object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this event rule. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: extraseventrulesdestroy method: DELETE description: Delete a event rule object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this event rule. required: true - name: api-extras-export-templates path: /api/extras/export-templates/ operations: - name: extrasexporttemplateslist method: GET description: Get a list of export template objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: as_attachment in: query type: boolean - name: auto_sync_enabled in: query type: boolean - name: created in: query type: array - name: created__empty in: query type: array - name: created__gt in: query type: array - name: created__gte in: query type: array - name: created__lt in: query type: array - name: created__lte in: query type: array - name: created__n in: query type: array - name: created_by_request in: query type: string - name: data_file_id in: query type: array description: Data file (ID) - name: data_file_id__n in: query type: array description: Data file (ID) - name: data_source_id in: query type: array description: Data source (ID) - name: data_source_id__n in: query type: array description: Data source (ID) - name: data_synced in: query type: array - name: data_synced__empty in: query type: boolean - name: data_synced__gt in: query type: array - name: data_synced__gte in: query type: array - name: data_synced__lt in: query type: array - name: data_synced__lte in: query type: array - name: data_synced__n in: query type: array - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: file_extension in: query type: array - name: file_extension__empty in: query type: boolean - name: file_extension__ic in: query type: array - name: file_extension__ie in: query type: array - name: file_extension__iew in: query type: array - name: file_extension__iregex in: query type: array - name: file_extension__isw in: query type: array - name: file_extension__n in: query type: array - name: file_extension__nic in: query type: array - name: file_extension__nie in: query type: array - name: file_extension__niew in: query type: array - name: file_extension__nisw in: query type: array - name: file_extension__regex in: query type: array - name: file_name in: query type: array - name: file_name__empty in: query type: boolean - name: file_name__ic in: query type: array - name: file_name__ie in: query type: array - name: file_name__iew in: query type: array - name: file_name__iregex in: query type: array - name: file_name__isw in: query type: array - name: file_name__n in: query type: array - name: file_name__nic in: query type: array - name: file_name__nie in: query type: array - name: file_name__niew in: query type: array - name: file_name__nisw in: query type: array - name: file_name__regex in: query type: array - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: last_updated in: query type: array - name: last_updated__empty in: query type: array - name: last_updated__gt in: query type: array - name: last_updated__gte in: query type: array - name: last_updated__lt in: query type: array - name: last_updated__lte in: query type: array - name: last_updated__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: mime_type in: query type: array - name: mime_type__empty in: query type: boolean - name: mime_type__ic in: query type: array - name: mime_type__ie in: query type: array - name: mime_type__iew in: query type: array - name: mime_type__iregex in: query type: array - name: mime_type__isw in: query type: array - name: mime_type__n in: query type: array - name: mime_type__nic in: query type: array - name: mime_type__nie in: query type: array - name: mime_type__niew in: query type: array - name: mime_type__nisw in: query type: array - name: mime_type__regex in: query type: array - name: modified_by_request in: query type: string - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: object_type in: query type: array - name: object_type__ic in: query type: array - name: object_type__ie in: query type: array - name: object_type__iew in: query type: array - name: object_type__iregex in: query type: array - name: object_type__isw in: query type: array - name: object_type__n in: query type: array - name: object_type__nic in: query type: array - name: object_type__nie in: query type: array - name: object_type__niew in: query type: array - name: object_type__nisw in: query type: array - name: object_type__regex in: query type: array - name: object_type_id in: query type: array - name: object_type_id__n in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: owner in: query type: array description: Owner (name) - name: owner__n in: query type: array description: Owner (name) - name: owner_group in: query type: array description: Owner Group (name) - name: owner_group__n in: query type: array description: Owner Group (name) - name: owner_group_id in: query type: array description: Owner Group (ID) - name: owner_group_id__n in: query type: array description: Owner Group (ID) - name: owner_id in: query type: array description: Owner (ID) - name: owner_id__n in: query type: array description: Owner (ID) - name: q in: query type: string description: Search - name: updated_by_request in: query type: string - name: extrasexporttemplatescreate method: POST description: Post a list of export template objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasexporttemplatesbulkupdate method: PUT description: Put a list of export template objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasexporttemplatesbulkpartialupdate method: PATCH description: Patch a list of export template objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasexporttemplatesbulkdestroy method: DELETE description: Delete a list of export template objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-extras-export-templates-id path: /api/extras/export-templates/{id}/ operations: - name: extrasexporttemplatesretrieve method: GET description: Get a export template object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this export template. required: true - name: extrasexporttemplatesupdate method: PUT description: Put a export template object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this export template. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: extrasexporttemplatespartialupdate method: PATCH description: Patch a export template object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this export template. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: extrasexporttemplatesdestroy method: DELETE description: Delete a export template object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this export template. required: true - name: api-extras-export-templates-id-sync path: /api/extras/export-templates/{id}/sync/ operations: - name: extrasexporttemplatessynccreate method: POST description: Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any). outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this export template. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: api-extras-image-attachments path: /api/extras/image-attachments/ operations: - name: extrasimageattachmentslist method: GET description: Get a list of image attachment objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: created in: query type: array - name: created__empty in: query type: array - name: created__gt in: query type: array - name: created__gte in: query type: array - name: created__lt in: query type: array - name: created__lte in: query type: array - name: created__n in: query type: array - name: created_by_request in: query type: string - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: image_height in: query type: array - name: image_height__empty in: query type: boolean - name: image_height__gt in: query type: array - name: image_height__gte in: query type: array - name: image_height__lt in: query type: array - name: image_height__lte in: query type: array - name: image_height__n in: query type: array - name: image_width in: query type: array - name: image_width__empty in: query type: boolean - name: image_width__gt in: query type: array - name: image_width__gte in: query type: array - name: image_width__lt in: query type: array - name: image_width__lte in: query type: array - name: image_width__n in: query type: array - name: last_updated in: query type: array - name: last_updated__empty in: query type: array - name: last_updated__gt in: query type: array - name: last_updated__gte in: query type: array - name: last_updated__lt in: query type: array - name: last_updated__lte in: query type: array - name: last_updated__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: modified_by_request in: query type: string - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: object_id in: query type: array - name: object_id__empty in: query type: boolean - name: object_id__gt in: query type: array - name: object_id__gte in: query type: array - name: object_id__lt in: query type: array - name: object_id__lte in: query type: array - name: object_id__n in: query type: array - name: object_type in: query type: array - name: object_type__n in: query type: array - name: object_type_id in: query type: integer - name: object_type_id__n in: query type: integer - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: q in: query type: string description: Search - name: updated_by_request in: query type: string - name: extrasimageattachmentscreate method: POST description: Post a list of image attachment objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasimageattachmentsbulkupdate method: PUT description: Put a list of image attachment objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasimageattachmentsbulkpartialupdate method: PATCH description: Patch a list of image attachment objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasimageattachmentsbulkdestroy method: DELETE description: Delete a list of image attachment objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-extras-image-attachments-id path: /api/extras/image-attachments/{id}/ operations: - name: extrasimageattachmentsretrieve method: GET description: Get a image attachment object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this image attachment. required: true - name: extrasimageattachmentsupdate method: PUT description: Put a image attachment object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this image attachment. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: extrasimageattachmentspartialupdate method: PATCH description: Patch a image attachment object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this image attachment. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: extrasimageattachmentsdestroy method: DELETE description: Delete a image attachment object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this image attachment. required: true - name: api-extras-journal-entries path: /api/extras/journal-entries/ operations: - name: extrasjournalentrieslist method: GET description: Get a list of journal entry objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: assigned_object_id in: query type: array - name: assigned_object_id__empty in: query type: boolean - name: assigned_object_id__gt in: query type: array - name: assigned_object_id__gte in: query type: array - name: assigned_object_id__lt in: query type: array - name: assigned_object_id__lte in: query type: array - name: assigned_object_id__n in: query type: array - name: assigned_object_type in: query type: array - name: assigned_object_type__n in: query type: array - name: assigned_object_type_id in: query type: array - name: assigned_object_type_id__n in: query type: array - name: created_after in: query type: string - name: created_before in: query type: string - name: created_by in: query type: array description: User (name) - name: created_by__n in: query type: array description: User (name) - name: created_by_id in: query type: array description: User (ID) - name: created_by_id__n in: query type: array description: User (ID) - name: created_by_request in: query type: string - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: kind in: query type: array - name: kind__empty in: query type: boolean - name: kind__ic in: query type: array - name: kind__ie in: query type: array - name: kind__iew in: query type: array - name: kind__iregex in: query type: array - name: kind__isw in: query type: array - name: kind__n in: query type: array - name: kind__nic in: query type: array - name: kind__nie in: query type: array - name: kind__niew in: query type: array - name: kind__nisw in: query type: array - name: kind__regex in: query type: array - name: last_updated in: query type: array - name: last_updated__empty in: query type: array - name: last_updated__gt in: query type: array - name: last_updated__gte in: query type: array - name: last_updated__lt in: query type: array - name: last_updated__lte in: query type: array - name: last_updated__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: modified_by_request in: query type: string - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: q in: query type: string description: Search - name: tag in: query type: array - name: tag__n in: query type: array - name: tag_id in: query type: array - name: tag_id__n in: query type: array - name: updated_by_request in: query type: string - name: extrasjournalentriescreate method: POST description: Post a list of journal entry objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasjournalentriesbulkupdate method: PUT description: Put a list of journal entry objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasjournalentriesbulkpartialupdate method: PATCH description: Patch a list of journal entry objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasjournalentriesbulkdestroy method: DELETE description: Delete a list of journal entry objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-extras-journal-entries-id path: /api/extras/journal-entries/{id}/ operations: - name: extrasjournalentriesretrieve method: GET description: Get a journal entry object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this journal entry. required: true - name: extrasjournalentriesupdate method: PUT description: Put a journal entry object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this journal entry. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: extrasjournalentriespartialupdate method: PATCH description: Patch a journal entry object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this journal entry. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: extrasjournalentriesdestroy method: DELETE description: Delete a journal entry object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this journal entry. required: true - name: api-extras-notification-groups path: /api/extras/notification-groups/ operations: - name: extrasnotificationgroupslist method: GET description: Get a list of notification group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: integer description: Number of results to return per page. - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: extrasnotificationgroupscreate method: POST description: Post a list of notification group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasnotificationgroupsbulkupdate method: PUT description: Put a list of notification group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasnotificationgroupsbulkpartialupdate method: PATCH description: Patch a list of notification group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasnotificationgroupsbulkdestroy method: DELETE description: Delete a list of notification group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-extras-notification-groups-id path: /api/extras/notification-groups/{id}/ operations: - name: extrasnotificationgroupsretrieve method: GET description: Get a notification group object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this notification group. required: true - name: extrasnotificationgroupsupdate method: PUT description: Put a notification group object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this notification group. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: extrasnotificationgroupspartialupdate method: PATCH description: Patch a notification group object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this notification group. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: extrasnotificationgroupsdestroy method: DELETE description: Delete a notification group object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this notification group. required: true - name: api-extras-notifications path: /api/extras/notifications/ operations: - name: extrasnotificationslist method: GET description: Get a list of notification objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: integer description: Number of results to return per page. - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: extrasnotificationscreate method: POST description: Post a list of notification objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasnotificationsbulkupdate method: PUT description: Put a list of notification objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasnotificationsbulkpartialupdate method: PATCH description: Patch a list of notification objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrasnotificationsbulkdestroy method: DELETE description: Delete a list of notification objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-extras-notifications-id path: /api/extras/notifications/{id}/ operations: - name: extrasnotificationsretrieve method: GET description: Get a notification object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this notification. required: true - name: extrasnotificationsupdate method: PUT description: Put a notification object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this notification. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: extrasnotificationspartialupdate method: PATCH description: Patch a notification object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this notification. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: extrasnotificationsdestroy method: DELETE description: Delete a notification object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this notification. required: true - name: api-extras-saved-filters path: /api/extras/saved-filters/ operations: - name: extrassavedfilterslist method: GET description: Get a list of saved filter objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: created in: query type: array - name: created__empty in: query type: array - name: created__gt in: query type: array - name: created__gte in: query type: array - name: created__lt in: query type: array - name: created__lte in: query type: array - name: created__n in: query type: array - name: created_by_request in: query type: string - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: enabled in: query type: boolean - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: last_updated in: query type: array - name: last_updated__empty in: query type: array - name: last_updated__gt in: query type: array - name: last_updated__gte in: query type: array - name: last_updated__lt in: query type: array - name: last_updated__lte in: query type: array - name: last_updated__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: modified_by_request in: query type: string - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: object_type in: query type: array - name: object_type__ic in: query type: array - name: object_type__ie in: query type: array - name: object_type__iew in: query type: array - name: object_type__iregex in: query type: array - name: object_type__isw in: query type: array - name: object_type__n in: query type: array - name: object_type__nic in: query type: array - name: object_type__nie in: query type: array - name: object_type__niew in: query type: array - name: object_type__nisw in: query type: array - name: object_type__regex in: query type: array - name: object_type_id in: query type: array - name: object_type_id__n in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: owner in: query type: array description: Owner (name) - name: owner__n in: query type: array description: Owner (name) - name: owner_group in: query type: array description: Owner Group (name) - name: owner_group__n in: query type: array description: Owner Group (name) - name: owner_group_id in: query type: array description: Owner Group (ID) - name: owner_group_id__n in: query type: array description: Owner Group (ID) - name: owner_id in: query type: array description: Owner (ID) - name: owner_id__n in: query type: array description: Owner (ID) - name: q in: query type: string description: Search - name: shared in: query type: boolean - name: slug in: query type: array - name: slug__empty in: query type: boolean - name: slug__ic in: query type: array - name: slug__ie in: query type: array - name: slug__iew in: query type: array - name: slug__iregex in: query type: array - name: slug__isw in: query type: array - name: slug__n in: query type: array - name: slug__nic in: query type: array - name: slug__nie in: query type: array - name: slug__niew in: query type: array - name: slug__nisw in: query type: array - name: slug__regex in: query type: array - name: updated_by_request in: query type: string - name: usable in: query type: boolean - name: user in: query type: array description: User (name) - name: user__n in: query type: array description: User (name) - name: user_id in: query type: array description: User (ID) - name: user_id__n in: query type: array description: User (ID) - name: weight in: query type: array - name: weight__empty in: query type: boolean - name: weight__gt in: query type: array - name: weight__gte in: query type: array - name: weight__lt in: query type: array - name: weight__lte in: query type: array - name: weight__n in: query type: array - name: extrassavedfilterscreate method: POST description: Post a list of saved filter objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrassavedfiltersbulkupdate method: PUT description: Put a list of saved filter objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrassavedfiltersbulkpartialupdate method: PATCH description: Patch a list of saved filter objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrassavedfiltersbulkdestroy method: DELETE description: Delete a list of saved filter objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-extras-saved-filters-id path: /api/extras/saved-filters/{id}/ operations: - name: extrassavedfiltersretrieve method: GET description: Get a saved filter object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this saved filter. required: true - name: extrassavedfiltersupdate method: PUT description: Put a saved filter object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this saved filter. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: extrassavedfilterspartialupdate method: PATCH description: Patch a saved filter object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this saved filter. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: extrassavedfiltersdestroy method: DELETE description: Delete a saved filter object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this saved filter. required: true - name: api-extras-scripts path: /api/extras/scripts/ operations: - name: extrasscriptslist method: GET description: Get a list of script objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: is_executable in: query type: boolean - name: limit in: query type: integer description: Number of results to return per page. - name: module_id in: query type: array description: Script module (ID) - name: module_id__n in: query type: array description: Script module (ID) - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: q in: query type: string description: Search - name: extrasscriptscreate method: POST description: Post a list of script objects. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-extras-scripts-upload path: /api/extras/scripts/upload/ operations: - name: extrasscriptsuploadcreate method: POST description: Post a list of script module objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-extras-scripts-id path: /api/extras/scripts/{id}/ operations: - name: extrasscriptsretrieve method: GET description: Get a script object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: extrasscriptsupdate method: PUT description: Put a script object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: extrasscriptspartialupdate method: PATCH description: Patch a script object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: false - name: extrasscriptsdestroy method: DELETE description: Delete a script object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: api-extras-subscriptions path: /api/extras/subscriptions/ operations: - name: extrassubscriptionslist method: GET description: Get a list of subscription objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: integer description: Number of results to return per page. - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: extrassubscriptionscreate method: POST description: Post a list of subscription objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrassubscriptionsbulkupdate method: PUT description: Put a list of subscription objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrassubscriptionsbulkpartialupdate method: PATCH description: Patch a list of subscription objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrassubscriptionsbulkdestroy method: DELETE description: Delete a list of subscription objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-extras-subscriptions-id path: /api/extras/subscriptions/{id}/ operations: - name: extrassubscriptionsretrieve method: GET description: Get a subscription object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this subscription. required: true - name: extrassubscriptionsupdate method: PUT description: Put a subscription object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this subscription. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: extrassubscriptionspartialupdate method: PATCH description: Patch a subscription object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this subscription. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: extrassubscriptionsdestroy method: DELETE description: Delete a subscription object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this subscription. required: true - name: api-extras-table-configs path: /api/extras/table-configs/ operations: - name: extrastableconfigslist method: GET description: Get a list of table config objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: created in: query type: array - name: created__empty in: query type: array - name: created__gt in: query type: array - name: created__gte in: query type: array - name: created__lt in: query type: array - name: created__lte in: query type: array - name: created__n in: query type: array - name: created_by_request in: query type: string - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: enabled in: query type: boolean - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: last_updated in: query type: array - name: last_updated__empty in: query type: array - name: last_updated__gt in: query type: array - name: last_updated__gte in: query type: array - name: last_updated__lt in: query type: array - name: last_updated__lte in: query type: array - name: last_updated__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: modified_by_request in: query type: string - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: object_type in: query type: array - name: object_type__n in: query type: array - name: object_type_id in: query type: array - name: object_type_id__n in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: q in: query type: string description: Search - name: shared in: query type: boolean - name: table in: query type: array - name: table__empty in: query type: boolean - name: table__ic in: query type: array - name: table__ie in: query type: array - name: table__iew in: query type: array - name: table__iregex in: query type: array - name: table__isw in: query type: array - name: table__n in: query type: array - name: table__nic in: query type: array - name: table__nie in: query type: array - name: table__niew in: query type: array - name: table__nisw in: query type: array - name: table__regex in: query type: array - name: updated_by_request in: query type: string - name: usable in: query type: boolean - name: user in: query type: array description: User (name) - name: user__n in: query type: array description: User (name) - name: user_id in: query type: array description: User (ID) - name: user_id__n in: query type: array description: User (ID) - name: weight in: query type: array - name: weight__empty in: query type: boolean - name: weight__gt in: query type: array - name: weight__gte in: query type: array - name: weight__lt in: query type: array - name: weight__lte in: query type: array - name: weight__n in: query type: array - name: extrastableconfigscreate method: POST description: Post a list of table config objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrastableconfigsbulkupdate method: PUT description: Put a list of table config objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrastableconfigsbulkpartialupdate method: PATCH description: Patch a list of table config objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrastableconfigsbulkdestroy method: DELETE description: Delete a list of table config objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-extras-table-configs-id path: /api/extras/table-configs/{id}/ operations: - name: extrastableconfigsretrieve method: GET description: Get a table config object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this table config. required: true - name: extrastableconfigsupdate method: PUT description: Put a table config object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this table config. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: extrastableconfigspartialupdate method: PATCH description: Patch a table config object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this table config. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: extrastableconfigsdestroy method: DELETE description: Delete a table config object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this table config. required: true - name: api-extras-tagged-objects path: /api/extras/tagged-objects/ operations: - name: extrastaggedobjectslist method: GET description: Get a list of tagged item objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: object_id in: query type: array - name: object_id__empty in: query type: boolean - name: object_id__gt in: query type: array - name: object_id__gte in: query type: array - name: object_id__lt in: query type: array - name: object_id__lte in: query type: array - name: object_id__n in: query type: array - name: object_type in: query type: array - name: object_type__n in: query type: array - name: object_type_id in: query type: array - name: object_type_id__n in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: q in: query type: string description: Search - name: tag in: query type: array - name: tag__n in: query type: array - name: tag_id in: query type: array - name: tag_id__n in: query type: array - name: api-extras-tagged-objects-id path: /api/extras/tagged-objects/{id}/ operations: - name: extrastaggedobjectsretrieve method: GET description: Get a tagged item object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this tagged item. required: true - name: api-extras-tags path: /api/extras/tags/ operations: - name: extrastagslist method: GET description: Get a list of tag objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: color in: query type: array - name: color__empty in: query type: boolean - name: color__ic in: query type: array - name: color__ie in: query type: array - name: color__iew in: query type: array - name: color__iregex in: query type: array - name: color__isw in: query type: array - name: color__n in: query type: array - name: color__nic in: query type: array - name: color__nie in: query type: array - name: color__niew in: query type: array - name: color__nisw in: query type: array - name: color__regex in: query type: array - name: content_type in: query type: array - name: content_type_id in: query type: array - name: created in: query type: array - name: created__empty in: query type: array - name: created__gt in: query type: array - name: created__gte in: query type: array - name: created__lt in: query type: array - name: created__lte in: query type: array - name: created__n in: query type: array - name: created_by_request in: query type: string - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: for_object_type_id in: query type: array - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: last_updated in: query type: array - name: last_updated__empty in: query type: array - name: last_updated__gt in: query type: array - name: last_updated__gte in: query type: array - name: last_updated__lt in: query type: array - name: last_updated__lte in: query type: array - name: last_updated__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: modified_by_request in: query type: string - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: object_types in: query type: array - name: object_types__n in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: owner in: query type: array description: Owner (name) - name: owner__n in: query type: array description: Owner (name) - name: owner_group in: query type: array description: Owner Group (name) - name: owner_group__n in: query type: array description: Owner Group (name) - name: owner_group_id in: query type: array description: Owner Group (ID) - name: owner_group_id__n in: query type: array description: Owner Group (ID) - name: owner_id in: query type: array description: Owner (ID) - name: owner_id__n in: query type: array description: Owner (ID) - name: q in: query type: string description: Search - name: slug in: query type: array - name: slug__empty in: query type: boolean - name: slug__ic in: query type: array - name: slug__ie in: query type: array - name: slug__iew in: query type: array - name: slug__iregex in: query type: array - name: slug__isw in: query type: array - name: slug__n in: query type: array - name: slug__nic in: query type: array - name: slug__nie in: query type: array - name: slug__niew in: query type: array - name: slug__nisw in: query type: array - name: slug__regex in: query type: array - name: updated_by_request in: query type: string - name: weight in: query type: array - name: weight__empty in: query type: boolean - name: weight__gt in: query type: array - name: weight__gte in: query type: array - name: weight__lt in: query type: array - name: weight__lte in: query type: array - name: weight__n in: query type: array - name: extrastagscreate method: POST description: Post a list of tag objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrastagsbulkupdate method: PUT description: Put a list of tag objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrastagsbulkpartialupdate method: PATCH description: Patch a list of tag objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extrastagsbulkdestroy method: DELETE description: Delete a list of tag objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-extras-tags-id path: /api/extras/tags/{id}/ operations: - name: extrastagsretrieve method: GET description: Get a tag object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this tag. required: true - name: extrastagsupdate method: PUT description: Put a tag object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this tag. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: extrastagspartialupdate method: PATCH description: Patch a tag object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this tag. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: extrastagsdestroy method: DELETE description: Delete a tag object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this tag. required: true - name: api-extras-webhooks path: /api/extras/webhooks/ operations: - name: extraswebhookslist method: GET description: Get a list of webhook objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ca_file_path in: query type: array - name: ca_file_path__empty in: query type: boolean - name: ca_file_path__ic in: query type: array - name: ca_file_path__ie in: query type: array - name: ca_file_path__iew in: query type: array - name: ca_file_path__iregex in: query type: array - name: ca_file_path__isw in: query type: array - name: ca_file_path__n in: query type: array - name: ca_file_path__nic in: query type: array - name: ca_file_path__nie in: query type: array - name: ca_file_path__niew in: query type: array - name: ca_file_path__nisw in: query type: array - name: ca_file_path__regex in: query type: array - name: created in: query type: array - name: created__empty in: query type: array - name: created__gt in: query type: array - name: created__gte in: query type: array - name: created__lt in: query type: array - name: created__lte in: query type: array - name: created__n in: query type: array - name: created_by_request in: query type: string - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: http_content_type in: query type: array - name: http_content_type__empty in: query type: boolean - name: http_content_type__ic in: query type: array - name: http_content_type__ie in: query type: array - name: http_content_type__iew in: query type: array - name: http_content_type__iregex in: query type: array - name: http_content_type__isw in: query type: array - name: http_content_type__n in: query type: array - name: http_content_type__nic in: query type: array - name: http_content_type__nie in: query type: array - name: http_content_type__niew in: query type: array - name: http_content_type__nisw in: query type: array - name: http_content_type__regex in: query type: array - name: http_method in: query type: array - name: http_method__empty in: query type: boolean - name: http_method__ic in: query type: array - name: http_method__ie in: query type: array - name: http_method__iew in: query type: array - name: http_method__iregex in: query type: array - name: http_method__isw in: query type: array - name: http_method__n in: query type: array - name: http_method__nic in: query type: array - name: http_method__nie in: query type: array - name: http_method__niew in: query type: array - name: http_method__nisw in: query type: array - name: http_method__regex in: query type: array - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: last_updated in: query type: array - name: last_updated__empty in: query type: array - name: last_updated__gt in: query type: array - name: last_updated__gte in: query type: array - name: last_updated__lt in: query type: array - name: last_updated__lte in: query type: array - name: last_updated__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: modified_by_request in: query type: string - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: owner in: query type: array description: Owner (name) - name: owner__n in: query type: array description: Owner (name) - name: owner_group in: query type: array description: Owner Group (name) - name: owner_group__n in: query type: array description: Owner Group (name) - name: owner_group_id in: query type: array description: Owner Group (ID) - name: owner_group_id__n in: query type: array description: Owner Group (ID) - name: owner_id in: query type: array description: Owner (ID) - name: owner_id__n in: query type: array description: Owner (ID) - name: payload_url in: query type: array - name: q in: query type: string description: Search - name: secret in: query type: array - name: secret__empty in: query type: boolean - name: secret__ic in: query type: array - name: secret__ie in: query type: array - name: secret__iew in: query type: array - name: secret__iregex in: query type: array - name: secret__isw in: query type: array - name: secret__n in: query type: array - name: secret__nic in: query type: array - name: secret__nie in: query type: array - name: secret__niew in: query type: array - name: secret__nisw in: query type: array - name: secret__regex in: query type: array - name: ssl_verification in: query type: boolean - name: tag in: query type: array - name: tag__n in: query type: array - name: tag_id in: query type: array - name: tag_id__n in: query type: array - name: updated_by_request in: query type: string - name: extraswebhookscreate method: POST description: Post a list of webhook objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extraswebhooksbulkupdate method: PUT description: Put a list of webhook objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extraswebhooksbulkpartialupdate method: PATCH description: Patch a list of webhook objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: extraswebhooksbulkdestroy method: DELETE description: Delete a list of webhook objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-extras-webhooks-id path: /api/extras/webhooks/{id}/ operations: - name: extraswebhooksretrieve method: GET description: Get a webhook object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this webhook. required: true - name: extraswebhooksupdate method: PUT description: Put a webhook object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this webhook. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: extraswebhookspartialupdate method: PATCH description: Patch a webhook object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this webhook. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: extraswebhooksdestroy method: DELETE description: Delete a webhook object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this webhook. required: true authentication: type: apikey key: sessionid value: '{{env.NETBOX_API_KEY}}' placement: cookie exposes: - type: rest namespace: netbox-extras-rest port: 8080 description: REST adapter for NetBox REST API — extras. One Spectral-compliant resource per consumed operation, prefixed with /v1. resources: - path: /v1/api/extras/bookmarks name: api-extras-bookmarks description: REST surface for api-extras-bookmarks. operations: - method: GET name: extrasbookmarkslist description: Get a list of bookmark objects. call: netbox-extras.extrasbookmarkslist with: created: rest.created id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n limit: rest.limit object_id: rest.object_id object_id__empty: rest.object_id__empty object_id__gt: rest.object_id__gt object_id__gte: rest.object_id__gte object_id__lt: rest.object_id__lt object_id__lte: rest.object_id__lte object_id__n: rest.object_id__n object_type: rest.object_type object_type__n: rest.object_type__n object_type_id: rest.object_type_id object_type_id__empty: rest.object_type_id__empty object_type_id__gt: rest.object_type_id__gt object_type_id__gte: rest.object_type_id__gte object_type_id__lt: rest.object_type_id__lt object_type_id__lte: rest.object_type_id__lte object_type_id__n: rest.object_type_id__n offset: rest.offset ordering: rest.ordering user: rest.user user__n: rest.user__n user_id: rest.user_id user_id__n: rest.user_id__n outputParameters: - type: object mapping: $. - method: POST name: extrasbookmarkscreate description: Post a list of bookmark objects. call: netbox-extras.extrasbookmarkscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: extrasbookmarksbulkupdate description: Put a list of bookmark objects. call: netbox-extras.extrasbookmarksbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrasbookmarksbulkpartialupdate description: Patch a list of bookmark objects. call: netbox-extras.extrasbookmarksbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrasbookmarksbulkdestroy description: Delete a list of bookmark objects. call: netbox-extras.extrasbookmarksbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/extras/bookmarks/{id} name: api-extras-bookmarks-id description: REST surface for api-extras-bookmarks-id. operations: - method: GET name: extrasbookmarksretrieve description: Get a bookmark object. call: netbox-extras.extrasbookmarksretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: extrasbookmarksupdate description: Put a bookmark object. call: netbox-extras.extrasbookmarksupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrasbookmarkspartialupdate description: Patch a bookmark object. call: netbox-extras.extrasbookmarkspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrasbookmarksdestroy description: Delete a bookmark object. call: netbox-extras.extrasbookmarksdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/extras/config-context-profiles name: api-extras-config-context-profiles description: REST surface for api-extras-config-context-profiles. operations: - method: GET name: extrasconfigcontextprofileslist description: Get a list of config context profile objects. call: netbox-extras.extrasconfigcontextprofileslist with: auto_sync_enabled: rest.auto_sync_enabled created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request data_file_id: rest.data_file_id data_file_id__n: rest.data_file_id__n data_source_id: rest.data_source_id data_source_id__n: rest.data_source_id__n data_synced: rest.data_synced data_synced__empty: rest.data_synced__empty data_synced__gt: rest.data_synced__gt data_synced__gte: rest.data_synced__gte data_synced__lt: rest.data_synced__lt data_synced__lte: rest.data_synced__lte data_synced__n: rest.data_synced__n description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit modified_by_request: rest.modified_by_request name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n q: rest.q tag: rest.tag tag__n: rest.tag__n tag_id: rest.tag_id tag_id__n: rest.tag_id__n updated_by_request: rest.updated_by_request outputParameters: - type: object mapping: $. - method: POST name: extrasconfigcontextprofilescreate description: Post a list of config context profile objects. call: netbox-extras.extrasconfigcontextprofilescreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: extrasconfigcontextprofilesbulkupdate description: Put a list of config context profile objects. call: netbox-extras.extrasconfigcontextprofilesbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrasconfigcontextprofilesbulkpartialupdate description: Patch a list of config context profile objects. call: netbox-extras.extrasconfigcontextprofilesbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrasconfigcontextprofilesbulkdestroy description: Delete a list of config context profile objects. call: netbox-extras.extrasconfigcontextprofilesbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/extras/config-context-profiles/{id} name: api-extras-config-context-profiles-id description: REST surface for api-extras-config-context-profiles-id. operations: - method: GET name: extrasconfigcontextprofilesretrieve description: Get a config context profile object. call: netbox-extras.extrasconfigcontextprofilesretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: extrasconfigcontextprofilesupdate description: Put a config context profile object. call: netbox-extras.extrasconfigcontextprofilesupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrasconfigcontextprofilespartialupdate description: Patch a config context profile object. call: netbox-extras.extrasconfigcontextprofilespartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrasconfigcontextprofilesdestroy description: Delete a config context profile object. call: netbox-extras.extrasconfigcontextprofilesdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/extras/config-context-profiles/{id}/sync name: api-extras-config-context-profiles-id-sync description: REST surface for api-extras-config-context-profiles-id-sync. operations: - method: POST name: extrasconfigcontextprofilessynccreate description: Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any). call: netbox-extras.extrasconfigcontextprofilessynccreate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/extras/config-contexts name: api-extras-config-contexts description: REST surface for api-extras-config-contexts. operations: - method: GET name: extrasconfigcontextslist description: Get a list of config context objects. call: netbox-extras.extrasconfigcontextslist with: auto_sync_enabled: rest.auto_sync_enabled cluster_group: rest.cluster_group cluster_group__n: rest.cluster_group__n cluster_group_id: rest.cluster_group_id cluster_group_id__n: rest.cluster_group_id__n cluster_id: rest.cluster_id cluster_id__n: rest.cluster_id__n cluster_type: rest.cluster_type cluster_type__n: rest.cluster_type__n cluster_type_id: rest.cluster_type_id cluster_type_id__n: rest.cluster_type_id__n created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request data_file_id: rest.data_file_id data_file_id__n: rest.data_file_id__n data_source_id: rest.data_source_id data_source_id__n: rest.data_source_id__n data_synced: rest.data_synced data_synced__empty: rest.data_synced__empty data_synced__gt: rest.data_synced__gt data_synced__gte: rest.data_synced__gte data_synced__lt: rest.data_synced__lt data_synced__lte: rest.data_synced__lte data_synced__n: rest.data_synced__n description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex device_role: rest.device_role device_role__n: rest.device_role__n device_role_id: rest.device_role_id device_role_id__n: rest.device_role_id__n device_type_id: rest.device_type_id device_type_id__n: rest.device_type_id__n id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n is_active: rest.is_active last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit location: rest.location location__n: rest.location__n location_id: rest.location_id location_id__n: rest.location_id__n modified_by_request: rest.modified_by_request name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n platform: rest.platform platform__n: rest.platform__n platform_id: rest.platform_id platform_id__n: rest.platform_id__n profile: rest.profile profile__n: rest.profile__n profile_id: rest.profile_id profile_id__n: rest.profile_id__n q: rest.q region: rest.region region__n: rest.region__n region_id: rest.region_id region_id__n: rest.region_id__n site: rest.site site__n: rest.site__n site_group: rest.site_group site_group__n: rest.site_group__n site_group_id: rest.site_group_id site_group_id__n: rest.site_group_id__n site_id: rest.site_id site_id__n: rest.site_id__n tag: rest.tag tag__n: rest.tag__n tag_id: rest.tag_id tag_id__n: rest.tag_id__n tenant: rest.tenant tenant__n: rest.tenant__n tenant_group: rest.tenant_group tenant_group__n: rest.tenant_group__n tenant_group_id: rest.tenant_group_id tenant_group_id__n: rest.tenant_group_id__n tenant_id: rest.tenant_id tenant_id__n: rest.tenant_id__n updated_by_request: rest.updated_by_request weight: rest.weight weight__empty: rest.weight__empty weight__gt: rest.weight__gt weight__gte: rest.weight__gte weight__lt: rest.weight__lt weight__lte: rest.weight__lte weight__n: rest.weight__n outputParameters: - type: object mapping: $. - method: POST name: extrasconfigcontextscreate description: Post a list of config context objects. call: netbox-extras.extrasconfigcontextscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: extrasconfigcontextsbulkupdate description: Put a list of config context objects. call: netbox-extras.extrasconfigcontextsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrasconfigcontextsbulkpartialupdate description: Patch a list of config context objects. call: netbox-extras.extrasconfigcontextsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrasconfigcontextsbulkdestroy description: Delete a list of config context objects. call: netbox-extras.extrasconfigcontextsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/extras/config-contexts/{id} name: api-extras-config-contexts-id description: REST surface for api-extras-config-contexts-id. operations: - method: GET name: extrasconfigcontextsretrieve description: Get a config context object. call: netbox-extras.extrasconfigcontextsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: extrasconfigcontextsupdate description: Put a config context object. call: netbox-extras.extrasconfigcontextsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrasconfigcontextspartialupdate description: Patch a config context object. call: netbox-extras.extrasconfigcontextspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrasconfigcontextsdestroy description: Delete a config context object. call: netbox-extras.extrasconfigcontextsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/extras/config-contexts/{id}/sync name: api-extras-config-contexts-id-sync description: REST surface for api-extras-config-contexts-id-sync. operations: - method: POST name: extrasconfigcontextssynccreate description: Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any). call: netbox-extras.extrasconfigcontextssynccreate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/extras/config-templates name: api-extras-config-templates description: REST surface for api-extras-config-templates. operations: - method: GET name: extrasconfigtemplateslist description: Get a list of config template objects. call: netbox-extras.extrasconfigtemplateslist with: as_attachment: rest.as_attachment auto_sync_enabled: rest.auto_sync_enabled created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request data_file_id: rest.data_file_id data_file_id__n: rest.data_file_id__n data_source_id: rest.data_source_id data_source_id__n: rest.data_source_id__n data_synced: rest.data_synced data_synced__empty: rest.data_synced__empty data_synced__gt: rest.data_synced__gt data_synced__gte: rest.data_synced__gte data_synced__lt: rest.data_synced__lt data_synced__lte: rest.data_synced__lte data_synced__n: rest.data_synced__n description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex file_extension: rest.file_extension file_extension__empty: rest.file_extension__empty file_extension__ic: rest.file_extension__ic file_extension__ie: rest.file_extension__ie file_extension__iew: rest.file_extension__iew file_extension__iregex: rest.file_extension__iregex file_extension__isw: rest.file_extension__isw file_extension__n: rest.file_extension__n file_extension__nic: rest.file_extension__nic file_extension__nie: rest.file_extension__nie file_extension__niew: rest.file_extension__niew file_extension__nisw: rest.file_extension__nisw file_extension__regex: rest.file_extension__regex file_name: rest.file_name file_name__empty: rest.file_name__empty file_name__ic: rest.file_name__ic file_name__ie: rest.file_name__ie file_name__iew: rest.file_name__iew file_name__iregex: rest.file_name__iregex file_name__isw: rest.file_name__isw file_name__n: rest.file_name__n file_name__nic: rest.file_name__nic file_name__nie: rest.file_name__nie file_name__niew: rest.file_name__niew file_name__nisw: rest.file_name__nisw file_name__regex: rest.file_name__regex id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit mime_type: rest.mime_type mime_type__empty: rest.mime_type__empty mime_type__ic: rest.mime_type__ic mime_type__ie: rest.mime_type__ie mime_type__iew: rest.mime_type__iew mime_type__iregex: rest.mime_type__iregex mime_type__isw: rest.mime_type__isw mime_type__n: rest.mime_type__n mime_type__nic: rest.mime_type__nic mime_type__nie: rest.mime_type__nie mime_type__niew: rest.mime_type__niew mime_type__nisw: rest.mime_type__nisw mime_type__regex: rest.mime_type__regex modified_by_request: rest.modified_by_request name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n q: rest.q tag: rest.tag tag__n: rest.tag__n tag_id: rest.tag_id tag_id__n: rest.tag_id__n updated_by_request: rest.updated_by_request outputParameters: - type: object mapping: $. - method: POST name: extrasconfigtemplatescreate description: Post a list of config template objects. call: netbox-extras.extrasconfigtemplatescreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: extrasconfigtemplatesbulkupdate description: Put a list of config template objects. call: netbox-extras.extrasconfigtemplatesbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrasconfigtemplatesbulkpartialupdate description: Patch a list of config template objects. call: netbox-extras.extrasconfigtemplatesbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrasconfigtemplatesbulkdestroy description: Delete a list of config template objects. call: netbox-extras.extrasconfigtemplatesbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/extras/config-templates/{id} name: api-extras-config-templates-id description: REST surface for api-extras-config-templates-id. operations: - method: GET name: extrasconfigtemplatesretrieve description: Get a config template object. call: netbox-extras.extrasconfigtemplatesretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: extrasconfigtemplatesupdate description: Put a config template object. call: netbox-extras.extrasconfigtemplatesupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrasconfigtemplatespartialupdate description: Patch a config template object. call: netbox-extras.extrasconfigtemplatespartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrasconfigtemplatesdestroy description: Delete a config template object. call: netbox-extras.extrasconfigtemplatesdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/extras/config-templates/{id}/render name: api-extras-config-templates-id-render description: REST surface for api-extras-config-templates-id-render. operations: - method: POST name: extrasconfigtemplatesrendercreate description: Render a ConfigTemplate using the context data provided (if any). If the client requests "text/plain" data, call: netbox-extras.extrasconfigtemplatesrendercreate with: format: rest.format id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/extras/config-templates/{id}/sync name: api-extras-config-templates-id-sync description: REST surface for api-extras-config-templates-id-sync. operations: - method: POST name: extrasconfigtemplatessynccreate description: Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any). call: netbox-extras.extrasconfigtemplatessynccreate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/extras/custom-field-choice-sets name: api-extras-custom-field-choice-sets description: REST surface for api-extras-custom-field-choice-sets. operations: - method: GET name: extrascustomfieldchoicesetslist description: Get a list of custom field choice set objects. call: netbox-extras.extrascustomfieldchoicesetslist with: base_choices: rest.base_choices base_choices__empty: rest.base_choices__empty base_choices__ic: rest.base_choices__ic base_choices__ie: rest.base_choices__ie base_choices__iew: rest.base_choices__iew base_choices__iregex: rest.base_choices__iregex base_choices__isw: rest.base_choices__isw base_choices__n: rest.base_choices__n base_choices__nic: rest.base_choices__nic base_choices__nie: rest.base_choices__nie base_choices__niew: rest.base_choices__niew base_choices__nisw: rest.base_choices__nisw base_choices__regex: rest.base_choices__regex choice: rest.choice created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit modified_by_request: rest.modified_by_request name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex offset: rest.offset order_alphabetically: rest.order_alphabetically ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n q: rest.q updated_by_request: rest.updated_by_request outputParameters: - type: object mapping: $. - method: POST name: extrascustomfieldchoicesetscreate description: Post a list of custom field choice set objects. call: netbox-extras.extrascustomfieldchoicesetscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: extrascustomfieldchoicesetsbulkupdate description: Put a list of custom field choice set objects. call: netbox-extras.extrascustomfieldchoicesetsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrascustomfieldchoicesetsbulkpartialupdate description: Patch a list of custom field choice set objects. call: netbox-extras.extrascustomfieldchoicesetsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrascustomfieldchoicesetsbulkdestroy description: Delete a list of custom field choice set objects. call: netbox-extras.extrascustomfieldchoicesetsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/extras/custom-field-choice-sets/{id} name: api-extras-custom-field-choice-sets-id description: REST surface for api-extras-custom-field-choice-sets-id. operations: - method: GET name: extrascustomfieldchoicesetsretrieve description: Get a custom field choice set object. call: netbox-extras.extrascustomfieldchoicesetsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: extrascustomfieldchoicesetsupdate description: Put a custom field choice set object. call: netbox-extras.extrascustomfieldchoicesetsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrascustomfieldchoicesetspartialupdate description: Patch a custom field choice set object. call: netbox-extras.extrascustomfieldchoicesetspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrascustomfieldchoicesetsdestroy description: Delete a custom field choice set object. call: netbox-extras.extrascustomfieldchoicesetsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/extras/custom-field-choice-sets/{id}/choices name: api-extras-custom-field-choice-sets-id-choices description: REST surface for api-extras-custom-field-choice-sets-id-choices. operations: - method: GET name: extrascustomfieldchoicesetschoicesretrieve description: Provides an endpoint to iterate through each choice in a set. call: netbox-extras.extrascustomfieldchoicesetschoicesretrieve with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/extras/custom-fields name: api-extras-custom-fields description: REST surface for api-extras-custom-fields. operations: - method: GET name: extrascustomfieldslist description: Get a list of custom field objects. call: netbox-extras.extrascustomfieldslist with: choice_set: rest.choice_set choice_set__n: rest.choice_set__n choice_set_id: rest.choice_set_id choice_set_id__n: rest.choice_set_id__n created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex filter_logic: rest.filter_logic filter_logic__empty: rest.filter_logic__empty filter_logic__ic: rest.filter_logic__ic filter_logic__ie: rest.filter_logic__ie filter_logic__iew: rest.filter_logic__iew filter_logic__iregex: rest.filter_logic__iregex filter_logic__isw: rest.filter_logic__isw filter_logic__n: rest.filter_logic__n filter_logic__nic: rest.filter_logic__nic filter_logic__nie: rest.filter_logic__nie filter_logic__niew: rest.filter_logic__niew filter_logic__nisw: rest.filter_logic__nisw filter_logic__regex: rest.filter_logic__regex group_name: rest.group_name group_name__empty: rest.group_name__empty group_name__ic: rest.group_name__ic group_name__ie: rest.group_name__ie group_name__iew: rest.group_name__iew group_name__iregex: rest.group_name__iregex group_name__isw: rest.group_name__isw group_name__n: rest.group_name__n group_name__nic: rest.group_name__nic group_name__nie: rest.group_name__nie group_name__niew: rest.group_name__niew group_name__nisw: rest.group_name__nisw group_name__regex: rest.group_name__regex id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n is_cloneable: rest.is_cloneable label: rest.label label__empty: rest.label__empty label__ic: rest.label__ic label__ie: rest.label__ie label__iew: rest.label__iew label__iregex: rest.label__iregex label__isw: rest.label__isw label__n: rest.label__n label__nic: rest.label__nic label__nie: rest.label__nie label__niew: rest.label__niew label__nisw: rest.label__nisw label__regex: rest.label__regex last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit modified_by_request: rest.modified_by_request name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex object_type: rest.object_type object_type__ic: rest.object_type__ic object_type__ie: rest.object_type__ie object_type__iew: rest.object_type__iew object_type__iregex: rest.object_type__iregex object_type__isw: rest.object_type__isw object_type__n: rest.object_type__n object_type__nic: rest.object_type__nic object_type__nie: rest.object_type__nie object_type__niew: rest.object_type__niew object_type__nisw: rest.object_type__nisw object_type__regex: rest.object_type__regex object_type_id: rest.object_type_id object_type_id__n: rest.object_type_id__n offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n q: rest.q related_object_type: rest.related_object_type related_object_type__n: rest.related_object_type__n related_object_type_id: rest.related_object_type_id related_object_type_id__n: rest.related_object_type_id__n required: rest.required search_weight: rest.search_weight search_weight__empty: rest.search_weight__empty search_weight__gt: rest.search_weight__gt search_weight__gte: rest.search_weight__gte search_weight__lt: rest.search_weight__lt search_weight__lte: rest.search_weight__lte search_weight__n: rest.search_weight__n type: rest.type type__empty: rest.type__empty type__ic: rest.type__ic type__ie: rest.type__ie type__iew: rest.type__iew type__iregex: rest.type__iregex type__isw: rest.type__isw type__n: rest.type__n type__nic: rest.type__nic type__nie: rest.type__nie type__niew: rest.type__niew type__nisw: rest.type__nisw type__regex: rest.type__regex ui_editable: rest.ui_editable ui_editable__empty: rest.ui_editable__empty ui_editable__ic: rest.ui_editable__ic ui_editable__ie: rest.ui_editable__ie ui_editable__iew: rest.ui_editable__iew ui_editable__iregex: rest.ui_editable__iregex ui_editable__isw: rest.ui_editable__isw ui_editable__n: rest.ui_editable__n ui_editable__nic: rest.ui_editable__nic ui_editable__nie: rest.ui_editable__nie ui_editable__niew: rest.ui_editable__niew ui_editable__nisw: rest.ui_editable__nisw ui_editable__regex: rest.ui_editable__regex ui_visible: rest.ui_visible ui_visible__empty: rest.ui_visible__empty ui_visible__ic: rest.ui_visible__ic ui_visible__ie: rest.ui_visible__ie ui_visible__iew: rest.ui_visible__iew ui_visible__iregex: rest.ui_visible__iregex ui_visible__isw: rest.ui_visible__isw ui_visible__n: rest.ui_visible__n ui_visible__nic: rest.ui_visible__nic ui_visible__nie: rest.ui_visible__nie ui_visible__niew: rest.ui_visible__niew ui_visible__nisw: rest.ui_visible__nisw ui_visible__regex: rest.ui_visible__regex unique: rest.unique updated_by_request: rest.updated_by_request validation_maximum: rest.validation_maximum validation_maximum__empty: rest.validation_maximum__empty validation_maximum__gt: rest.validation_maximum__gt validation_maximum__gte: rest.validation_maximum__gte validation_maximum__lt: rest.validation_maximum__lt validation_maximum__lte: rest.validation_maximum__lte validation_maximum__n: rest.validation_maximum__n validation_minimum: rest.validation_minimum validation_minimum__empty: rest.validation_minimum__empty validation_minimum__gt: rest.validation_minimum__gt validation_minimum__gte: rest.validation_minimum__gte validation_minimum__lt: rest.validation_minimum__lt validation_minimum__lte: rest.validation_minimum__lte validation_minimum__n: rest.validation_minimum__n validation_regex: rest.validation_regex validation_regex__empty: rest.validation_regex__empty validation_regex__ic: rest.validation_regex__ic validation_regex__ie: rest.validation_regex__ie validation_regex__iew: rest.validation_regex__iew validation_regex__iregex: rest.validation_regex__iregex validation_regex__isw: rest.validation_regex__isw validation_regex__n: rest.validation_regex__n validation_regex__nic: rest.validation_regex__nic validation_regex__nie: rest.validation_regex__nie validation_regex__niew: rest.validation_regex__niew validation_regex__nisw: rest.validation_regex__nisw validation_regex__regex: rest.validation_regex__regex weight: rest.weight weight__empty: rest.weight__empty weight__gt: rest.weight__gt weight__gte: rest.weight__gte weight__lt: rest.weight__lt weight__lte: rest.weight__lte weight__n: rest.weight__n outputParameters: - type: object mapping: $. - method: POST name: extrascustomfieldscreate description: Post a list of custom field objects. call: netbox-extras.extrascustomfieldscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: extrascustomfieldsbulkupdate description: Put a list of custom field objects. call: netbox-extras.extrascustomfieldsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrascustomfieldsbulkpartialupdate description: Patch a list of custom field objects. call: netbox-extras.extrascustomfieldsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrascustomfieldsbulkdestroy description: Delete a list of custom field objects. call: netbox-extras.extrascustomfieldsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/extras/custom-fields/{id} name: api-extras-custom-fields-id description: REST surface for api-extras-custom-fields-id. operations: - method: GET name: extrascustomfieldsretrieve description: Get a custom field object. call: netbox-extras.extrascustomfieldsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: extrascustomfieldsupdate description: Put a custom field object. call: netbox-extras.extrascustomfieldsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrascustomfieldspartialupdate description: Patch a custom field object. call: netbox-extras.extrascustomfieldspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrascustomfieldsdestroy description: Delete a custom field object. call: netbox-extras.extrascustomfieldsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/extras/custom-links name: api-extras-custom-links description: REST surface for api-extras-custom-links. operations: - method: GET name: extrascustomlinkslist description: Get a list of custom link objects. call: netbox-extras.extrascustomlinkslist with: button_class: rest.button_class button_class__empty: rest.button_class__empty button_class__ic: rest.button_class__ic button_class__ie: rest.button_class__ie button_class__iew: rest.button_class__iew button_class__iregex: rest.button_class__iregex button_class__isw: rest.button_class__isw button_class__n: rest.button_class__n button_class__nic: rest.button_class__nic button_class__nie: rest.button_class__nie button_class__niew: rest.button_class__niew button_class__nisw: rest.button_class__nisw button_class__regex: rest.button_class__regex created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request enabled: rest.enabled group_name: rest.group_name group_name__empty: rest.group_name__empty group_name__ic: rest.group_name__ic group_name__ie: rest.group_name__ie group_name__iew: rest.group_name__iew group_name__iregex: rest.group_name__iregex group_name__isw: rest.group_name__isw group_name__n: rest.group_name__n group_name__nic: rest.group_name__nic group_name__nie: rest.group_name__nie group_name__niew: rest.group_name__niew group_name__nisw: rest.group_name__nisw group_name__regex: rest.group_name__regex id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit link_text: rest.link_text link_text__ic: rest.link_text__ic link_text__ie: rest.link_text__ie link_text__iew: rest.link_text__iew link_text__iregex: rest.link_text__iregex link_text__isw: rest.link_text__isw link_text__n: rest.link_text__n link_text__nic: rest.link_text__nic link_text__nie: rest.link_text__nie link_text__niew: rest.link_text__niew link_text__nisw: rest.link_text__nisw link_text__regex: rest.link_text__regex link_url: rest.link_url link_url__ic: rest.link_url__ic link_url__ie: rest.link_url__ie link_url__iew: rest.link_url__iew link_url__iregex: rest.link_url__iregex link_url__isw: rest.link_url__isw link_url__n: rest.link_url__n link_url__nic: rest.link_url__nic link_url__nie: rest.link_url__nie link_url__niew: rest.link_url__niew link_url__nisw: rest.link_url__nisw link_url__regex: rest.link_url__regex modified_by_request: rest.modified_by_request name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex new_window: rest.new_window object_type: rest.object_type object_type__ic: rest.object_type__ic object_type__ie: rest.object_type__ie object_type__iew: rest.object_type__iew object_type__iregex: rest.object_type__iregex object_type__isw: rest.object_type__isw object_type__n: rest.object_type__n object_type__nic: rest.object_type__nic object_type__nie: rest.object_type__nie object_type__niew: rest.object_type__niew object_type__nisw: rest.object_type__nisw object_type__regex: rest.object_type__regex object_type_id: rest.object_type_id object_type_id__n: rest.object_type_id__n offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n q: rest.q updated_by_request: rest.updated_by_request weight: rest.weight weight__empty: rest.weight__empty weight__gt: rest.weight__gt weight__gte: rest.weight__gte weight__lt: rest.weight__lt weight__lte: rest.weight__lte weight__n: rest.weight__n outputParameters: - type: object mapping: $. - method: POST name: extrascustomlinkscreate description: Post a list of custom link objects. call: netbox-extras.extrascustomlinkscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: extrascustomlinksbulkupdate description: Put a list of custom link objects. call: netbox-extras.extrascustomlinksbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrascustomlinksbulkpartialupdate description: Patch a list of custom link objects. call: netbox-extras.extrascustomlinksbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrascustomlinksbulkdestroy description: Delete a list of custom link objects. call: netbox-extras.extrascustomlinksbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/extras/custom-links/{id} name: api-extras-custom-links-id description: REST surface for api-extras-custom-links-id. operations: - method: GET name: extrascustomlinksretrieve description: Get a custom link object. call: netbox-extras.extrascustomlinksretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: extrascustomlinksupdate description: Put a custom link object. call: netbox-extras.extrascustomlinksupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrascustomlinkspartialupdate description: Patch a custom link object. call: netbox-extras.extrascustomlinkspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrascustomlinksdestroy description: Delete a custom link object. call: netbox-extras.extrascustomlinksdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/extras/dashboard name: api-extras-dashboard description: REST surface for api-extras-dashboard. operations: - method: GET name: extrasdashboardretrieve description: Get a list of dashboard objects. call: netbox-extras.extrasdashboardretrieve outputParameters: - type: object mapping: $. - method: PUT name: extrasdashboardupdate description: Put a list of dashboard objects. call: netbox-extras.extrasdashboardupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrasdashboardpartialupdate description: Patch a list of dashboard objects. call: netbox-extras.extrasdashboardpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrasdashboarddestroy description: Delete a list of dashboard objects. call: netbox-extras.extrasdashboarddestroy outputParameters: - type: object mapping: $. - path: /v1/api/extras/event-rules name: api-extras-event-rules description: REST surface for api-extras-event-rules. operations: - method: GET name: extraseventruleslist description: Get a list of event rule objects. call: netbox-extras.extraseventruleslist with: action_object_id: rest.action_object_id action_object_id__empty: rest.action_object_id__empty action_object_id__gt: rest.action_object_id__gt action_object_id__gte: rest.action_object_id__gte action_object_id__lt: rest.action_object_id__lt action_object_id__lte: rest.action_object_id__lte action_object_id__n: rest.action_object_id__n action_object_type: rest.action_object_type action_object_type__n: rest.action_object_type__n action_type: rest.action_type action_type__empty: rest.action_type__empty action_type__ic: rest.action_type__ic action_type__ie: rest.action_type__ie action_type__iew: rest.action_type__iew action_type__iregex: rest.action_type__iregex action_type__isw: rest.action_type__isw action_type__n: rest.action_type__n action_type__nic: rest.action_type__nic action_type__nie: rest.action_type__nie action_type__niew: rest.action_type__niew action_type__nisw: rest.action_type__nisw action_type__regex: rest.action_type__regex created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex enabled: rest.enabled event_type: rest.event_type id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit modified_by_request: rest.modified_by_request name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex object_type: rest.object_type object_type__ic: rest.object_type__ic object_type__ie: rest.object_type__ie object_type__iew: rest.object_type__iew object_type__iregex: rest.object_type__iregex object_type__isw: rest.object_type__isw object_type__n: rest.object_type__n object_type__nic: rest.object_type__nic object_type__nie: rest.object_type__nie object_type__niew: rest.object_type__niew object_type__nisw: rest.object_type__nisw object_type__regex: rest.object_type__regex object_type_id: rest.object_type_id object_type_id__n: rest.object_type_id__n offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n q: rest.q tag: rest.tag tag__n: rest.tag__n tag_id: rest.tag_id tag_id__n: rest.tag_id__n updated_by_request: rest.updated_by_request outputParameters: - type: object mapping: $. - method: POST name: extraseventrulescreate description: Post a list of event rule objects. call: netbox-extras.extraseventrulescreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: extraseventrulesbulkupdate description: Put a list of event rule objects. call: netbox-extras.extraseventrulesbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extraseventrulesbulkpartialupdate description: Patch a list of event rule objects. call: netbox-extras.extraseventrulesbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extraseventrulesbulkdestroy description: Delete a list of event rule objects. call: netbox-extras.extraseventrulesbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/extras/event-rules/{id} name: api-extras-event-rules-id description: REST surface for api-extras-event-rules-id. operations: - method: GET name: extraseventrulesretrieve description: Get a event rule object. call: netbox-extras.extraseventrulesretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: extraseventrulesupdate description: Put a event rule object. call: netbox-extras.extraseventrulesupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extraseventrulespartialupdate description: Patch a event rule object. call: netbox-extras.extraseventrulespartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extraseventrulesdestroy description: Delete a event rule object. call: netbox-extras.extraseventrulesdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/extras/export-templates name: api-extras-export-templates description: REST surface for api-extras-export-templates. operations: - method: GET name: extrasexporttemplateslist description: Get a list of export template objects. call: netbox-extras.extrasexporttemplateslist with: as_attachment: rest.as_attachment auto_sync_enabled: rest.auto_sync_enabled created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request data_file_id: rest.data_file_id data_file_id__n: rest.data_file_id__n data_source_id: rest.data_source_id data_source_id__n: rest.data_source_id__n data_synced: rest.data_synced data_synced__empty: rest.data_synced__empty data_synced__gt: rest.data_synced__gt data_synced__gte: rest.data_synced__gte data_synced__lt: rest.data_synced__lt data_synced__lte: rest.data_synced__lte data_synced__n: rest.data_synced__n description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex file_extension: rest.file_extension file_extension__empty: rest.file_extension__empty file_extension__ic: rest.file_extension__ic file_extension__ie: rest.file_extension__ie file_extension__iew: rest.file_extension__iew file_extension__iregex: rest.file_extension__iregex file_extension__isw: rest.file_extension__isw file_extension__n: rest.file_extension__n file_extension__nic: rest.file_extension__nic file_extension__nie: rest.file_extension__nie file_extension__niew: rest.file_extension__niew file_extension__nisw: rest.file_extension__nisw file_extension__regex: rest.file_extension__regex file_name: rest.file_name file_name__empty: rest.file_name__empty file_name__ic: rest.file_name__ic file_name__ie: rest.file_name__ie file_name__iew: rest.file_name__iew file_name__iregex: rest.file_name__iregex file_name__isw: rest.file_name__isw file_name__n: rest.file_name__n file_name__nic: rest.file_name__nic file_name__nie: rest.file_name__nie file_name__niew: rest.file_name__niew file_name__nisw: rest.file_name__nisw file_name__regex: rest.file_name__regex id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit mime_type: rest.mime_type mime_type__empty: rest.mime_type__empty mime_type__ic: rest.mime_type__ic mime_type__ie: rest.mime_type__ie mime_type__iew: rest.mime_type__iew mime_type__iregex: rest.mime_type__iregex mime_type__isw: rest.mime_type__isw mime_type__n: rest.mime_type__n mime_type__nic: rest.mime_type__nic mime_type__nie: rest.mime_type__nie mime_type__niew: rest.mime_type__niew mime_type__nisw: rest.mime_type__nisw mime_type__regex: rest.mime_type__regex modified_by_request: rest.modified_by_request name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex object_type: rest.object_type object_type__ic: rest.object_type__ic object_type__ie: rest.object_type__ie object_type__iew: rest.object_type__iew object_type__iregex: rest.object_type__iregex object_type__isw: rest.object_type__isw object_type__n: rest.object_type__n object_type__nic: rest.object_type__nic object_type__nie: rest.object_type__nie object_type__niew: rest.object_type__niew object_type__nisw: rest.object_type__nisw object_type__regex: rest.object_type__regex object_type_id: rest.object_type_id object_type_id__n: rest.object_type_id__n offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n q: rest.q updated_by_request: rest.updated_by_request outputParameters: - type: object mapping: $. - method: POST name: extrasexporttemplatescreate description: Post a list of export template objects. call: netbox-extras.extrasexporttemplatescreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: extrasexporttemplatesbulkupdate description: Put a list of export template objects. call: netbox-extras.extrasexporttemplatesbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrasexporttemplatesbulkpartialupdate description: Patch a list of export template objects. call: netbox-extras.extrasexporttemplatesbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrasexporttemplatesbulkdestroy description: Delete a list of export template objects. call: netbox-extras.extrasexporttemplatesbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/extras/export-templates/{id} name: api-extras-export-templates-id description: REST surface for api-extras-export-templates-id. operations: - method: GET name: extrasexporttemplatesretrieve description: Get a export template object. call: netbox-extras.extrasexporttemplatesretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: extrasexporttemplatesupdate description: Put a export template object. call: netbox-extras.extrasexporttemplatesupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrasexporttemplatespartialupdate description: Patch a export template object. call: netbox-extras.extrasexporttemplatespartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrasexporttemplatesdestroy description: Delete a export template object. call: netbox-extras.extrasexporttemplatesdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/extras/export-templates/{id}/sync name: api-extras-export-templates-id-sync description: REST surface for api-extras-export-templates-id-sync. operations: - method: POST name: extrasexporttemplatessynccreate description: Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any). call: netbox-extras.extrasexporttemplatessynccreate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/extras/image-attachments name: api-extras-image-attachments description: REST surface for api-extras-image-attachments. operations: - method: GET name: extrasimageattachmentslist description: Get a list of image attachment objects. call: netbox-extras.extrasimageattachmentslist with: created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n image_height: rest.image_height image_height__empty: rest.image_height__empty image_height__gt: rest.image_height__gt image_height__gte: rest.image_height__gte image_height__lt: rest.image_height__lt image_height__lte: rest.image_height__lte image_height__n: rest.image_height__n image_width: rest.image_width image_width__empty: rest.image_width__empty image_width__gt: rest.image_width__gt image_width__gte: rest.image_width__gte image_width__lt: rest.image_width__lt image_width__lte: rest.image_width__lte image_width__n: rest.image_width__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit modified_by_request: rest.modified_by_request name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex object_id: rest.object_id object_id__empty: rest.object_id__empty object_id__gt: rest.object_id__gt object_id__gte: rest.object_id__gte object_id__lt: rest.object_id__lt object_id__lte: rest.object_id__lte object_id__n: rest.object_id__n object_type: rest.object_type object_type__n: rest.object_type__n object_type_id: rest.object_type_id object_type_id__n: rest.object_type_id__n offset: rest.offset ordering: rest.ordering q: rest.q updated_by_request: rest.updated_by_request outputParameters: - type: object mapping: $. - method: POST name: extrasimageattachmentscreate description: Post a list of image attachment objects. call: netbox-extras.extrasimageattachmentscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: extrasimageattachmentsbulkupdate description: Put a list of image attachment objects. call: netbox-extras.extrasimageattachmentsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrasimageattachmentsbulkpartialupdate description: Patch a list of image attachment objects. call: netbox-extras.extrasimageattachmentsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrasimageattachmentsbulkdestroy description: Delete a list of image attachment objects. call: netbox-extras.extrasimageattachmentsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/extras/image-attachments/{id} name: api-extras-image-attachments-id description: REST surface for api-extras-image-attachments-id. operations: - method: GET name: extrasimageattachmentsretrieve description: Get a image attachment object. call: netbox-extras.extrasimageattachmentsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: extrasimageattachmentsupdate description: Put a image attachment object. call: netbox-extras.extrasimageattachmentsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrasimageattachmentspartialupdate description: Patch a image attachment object. call: netbox-extras.extrasimageattachmentspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrasimageattachmentsdestroy description: Delete a image attachment object. call: netbox-extras.extrasimageattachmentsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/extras/journal-entries name: api-extras-journal-entries description: REST surface for api-extras-journal-entries. operations: - method: GET name: extrasjournalentrieslist description: Get a list of journal entry objects. call: netbox-extras.extrasjournalentrieslist with: assigned_object_id: rest.assigned_object_id assigned_object_id__empty: rest.assigned_object_id__empty assigned_object_id__gt: rest.assigned_object_id__gt assigned_object_id__gte: rest.assigned_object_id__gte assigned_object_id__lt: rest.assigned_object_id__lt assigned_object_id__lte: rest.assigned_object_id__lte assigned_object_id__n: rest.assigned_object_id__n assigned_object_type: rest.assigned_object_type assigned_object_type__n: rest.assigned_object_type__n assigned_object_type_id: rest.assigned_object_type_id assigned_object_type_id__n: rest.assigned_object_type_id__n created_after: rest.created_after created_before: rest.created_before created_by: rest.created_by created_by__n: rest.created_by__n created_by_id: rest.created_by_id created_by_id__n: rest.created_by_id__n created_by_request: rest.created_by_request id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n kind: rest.kind kind__empty: rest.kind__empty kind__ic: rest.kind__ic kind__ie: rest.kind__ie kind__iew: rest.kind__iew kind__iregex: rest.kind__iregex kind__isw: rest.kind__isw kind__n: rest.kind__n kind__nic: rest.kind__nic kind__nie: rest.kind__nie kind__niew: rest.kind__niew kind__nisw: rest.kind__nisw kind__regex: rest.kind__regex last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit modified_by_request: rest.modified_by_request offset: rest.offset ordering: rest.ordering q: rest.q tag: rest.tag tag__n: rest.tag__n tag_id: rest.tag_id tag_id__n: rest.tag_id__n updated_by_request: rest.updated_by_request outputParameters: - type: object mapping: $. - method: POST name: extrasjournalentriescreate description: Post a list of journal entry objects. call: netbox-extras.extrasjournalentriescreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: extrasjournalentriesbulkupdate description: Put a list of journal entry objects. call: netbox-extras.extrasjournalentriesbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrasjournalentriesbulkpartialupdate description: Patch a list of journal entry objects. call: netbox-extras.extrasjournalentriesbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrasjournalentriesbulkdestroy description: Delete a list of journal entry objects. call: netbox-extras.extrasjournalentriesbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/extras/journal-entries/{id} name: api-extras-journal-entries-id description: REST surface for api-extras-journal-entries-id. operations: - method: GET name: extrasjournalentriesretrieve description: Get a journal entry object. call: netbox-extras.extrasjournalentriesretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: extrasjournalentriesupdate description: Put a journal entry object. call: netbox-extras.extrasjournalentriesupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrasjournalentriespartialupdate description: Patch a journal entry object. call: netbox-extras.extrasjournalentriespartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrasjournalentriesdestroy description: Delete a journal entry object. call: netbox-extras.extrasjournalentriesdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/extras/notification-groups name: api-extras-notification-groups description: REST surface for api-extras-notification-groups. operations: - method: GET name: extrasnotificationgroupslist description: Get a list of notification group objects. call: netbox-extras.extrasnotificationgroupslist with: limit: rest.limit offset: rest.offset ordering: rest.ordering outputParameters: - type: object mapping: $. - method: POST name: extrasnotificationgroupscreate description: Post a list of notification group objects. call: netbox-extras.extrasnotificationgroupscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: extrasnotificationgroupsbulkupdate description: Put a list of notification group objects. call: netbox-extras.extrasnotificationgroupsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrasnotificationgroupsbulkpartialupdate description: Patch a list of notification group objects. call: netbox-extras.extrasnotificationgroupsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrasnotificationgroupsbulkdestroy description: Delete a list of notification group objects. call: netbox-extras.extrasnotificationgroupsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/extras/notification-groups/{id} name: api-extras-notification-groups-id description: REST surface for api-extras-notification-groups-id. operations: - method: GET name: extrasnotificationgroupsretrieve description: Get a notification group object. call: netbox-extras.extrasnotificationgroupsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: extrasnotificationgroupsupdate description: Put a notification group object. call: netbox-extras.extrasnotificationgroupsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrasnotificationgroupspartialupdate description: Patch a notification group object. call: netbox-extras.extrasnotificationgroupspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrasnotificationgroupsdestroy description: Delete a notification group object. call: netbox-extras.extrasnotificationgroupsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/extras/notifications name: api-extras-notifications description: REST surface for api-extras-notifications. operations: - method: GET name: extrasnotificationslist description: Get a list of notification objects. call: netbox-extras.extrasnotificationslist with: limit: rest.limit offset: rest.offset ordering: rest.ordering outputParameters: - type: object mapping: $. - method: POST name: extrasnotificationscreate description: Post a list of notification objects. call: netbox-extras.extrasnotificationscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: extrasnotificationsbulkupdate description: Put a list of notification objects. call: netbox-extras.extrasnotificationsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrasnotificationsbulkpartialupdate description: Patch a list of notification objects. call: netbox-extras.extrasnotificationsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrasnotificationsbulkdestroy description: Delete a list of notification objects. call: netbox-extras.extrasnotificationsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/extras/notifications/{id} name: api-extras-notifications-id description: REST surface for api-extras-notifications-id. operations: - method: GET name: extrasnotificationsretrieve description: Get a notification object. call: netbox-extras.extrasnotificationsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: extrasnotificationsupdate description: Put a notification object. call: netbox-extras.extrasnotificationsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrasnotificationspartialupdate description: Patch a notification object. call: netbox-extras.extrasnotificationspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrasnotificationsdestroy description: Delete a notification object. call: netbox-extras.extrasnotificationsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/extras/saved-filters name: api-extras-saved-filters description: REST surface for api-extras-saved-filters. operations: - method: GET name: extrassavedfilterslist description: Get a list of saved filter objects. call: netbox-extras.extrassavedfilterslist with: created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex enabled: rest.enabled id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit modified_by_request: rest.modified_by_request name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex object_type: rest.object_type object_type__ic: rest.object_type__ic object_type__ie: rest.object_type__ie object_type__iew: rest.object_type__iew object_type__iregex: rest.object_type__iregex object_type__isw: rest.object_type__isw object_type__n: rest.object_type__n object_type__nic: rest.object_type__nic object_type__nie: rest.object_type__nie object_type__niew: rest.object_type__niew object_type__nisw: rest.object_type__nisw object_type__regex: rest.object_type__regex object_type_id: rest.object_type_id object_type_id__n: rest.object_type_id__n offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n q: rest.q shared: rest.shared slug: rest.slug slug__empty: rest.slug__empty slug__ic: rest.slug__ic slug__ie: rest.slug__ie slug__iew: rest.slug__iew slug__iregex: rest.slug__iregex slug__isw: rest.slug__isw slug__n: rest.slug__n slug__nic: rest.slug__nic slug__nie: rest.slug__nie slug__niew: rest.slug__niew slug__nisw: rest.slug__nisw slug__regex: rest.slug__regex updated_by_request: rest.updated_by_request usable: rest.usable user: rest.user user__n: rest.user__n user_id: rest.user_id user_id__n: rest.user_id__n weight: rest.weight weight__empty: rest.weight__empty weight__gt: rest.weight__gt weight__gte: rest.weight__gte weight__lt: rest.weight__lt weight__lte: rest.weight__lte weight__n: rest.weight__n outputParameters: - type: object mapping: $. - method: POST name: extrassavedfilterscreate description: Post a list of saved filter objects. call: netbox-extras.extrassavedfilterscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: extrassavedfiltersbulkupdate description: Put a list of saved filter objects. call: netbox-extras.extrassavedfiltersbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrassavedfiltersbulkpartialupdate description: Patch a list of saved filter objects. call: netbox-extras.extrassavedfiltersbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrassavedfiltersbulkdestroy description: Delete a list of saved filter objects. call: netbox-extras.extrassavedfiltersbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/extras/saved-filters/{id} name: api-extras-saved-filters-id description: REST surface for api-extras-saved-filters-id. operations: - method: GET name: extrassavedfiltersretrieve description: Get a saved filter object. call: netbox-extras.extrassavedfiltersretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: extrassavedfiltersupdate description: Put a saved filter object. call: netbox-extras.extrassavedfiltersupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrassavedfilterspartialupdate description: Patch a saved filter object. call: netbox-extras.extrassavedfilterspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrassavedfiltersdestroy description: Delete a saved filter object. call: netbox-extras.extrassavedfiltersdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/extras/scripts name: api-extras-scripts description: REST surface for api-extras-scripts. operations: - method: GET name: extrasscriptslist description: Get a list of script objects. call: netbox-extras.extrasscriptslist with: id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n is_executable: rest.is_executable limit: rest.limit module_id: rest.module_id module_id__n: rest.module_id__n name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex offset: rest.offset ordering: rest.ordering q: rest.q outputParameters: - type: object mapping: $. - method: POST name: extrasscriptscreate description: Post a list of script objects. call: netbox-extras.extrasscriptscreate outputParameters: - type: object mapping: $. - path: /v1/api/extras/scripts/upload name: api-extras-scripts-upload description: REST surface for api-extras-scripts-upload. operations: - method: POST name: extrasscriptsuploadcreate description: Post a list of script module objects. call: netbox-extras.extrasscriptsuploadcreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/extras/scripts/{id} name: api-extras-scripts-id description: REST surface for api-extras-scripts-id. operations: - method: GET name: extrasscriptsretrieve description: Get a script object. call: netbox-extras.extrasscriptsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: extrasscriptsupdate description: Put a script object. call: netbox-extras.extrasscriptsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrasscriptspartialupdate description: Patch a script object. call: netbox-extras.extrasscriptspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrasscriptsdestroy description: Delete a script object. call: netbox-extras.extrasscriptsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/extras/subscriptions name: api-extras-subscriptions description: REST surface for api-extras-subscriptions. operations: - method: GET name: extrassubscriptionslist description: Get a list of subscription objects. call: netbox-extras.extrassubscriptionslist with: limit: rest.limit offset: rest.offset ordering: rest.ordering outputParameters: - type: object mapping: $. - method: POST name: extrassubscriptionscreate description: Post a list of subscription objects. call: netbox-extras.extrassubscriptionscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: extrassubscriptionsbulkupdate description: Put a list of subscription objects. call: netbox-extras.extrassubscriptionsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrassubscriptionsbulkpartialupdate description: Patch a list of subscription objects. call: netbox-extras.extrassubscriptionsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrassubscriptionsbulkdestroy description: Delete a list of subscription objects. call: netbox-extras.extrassubscriptionsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/extras/subscriptions/{id} name: api-extras-subscriptions-id description: REST surface for api-extras-subscriptions-id. operations: - method: GET name: extrassubscriptionsretrieve description: Get a subscription object. call: netbox-extras.extrassubscriptionsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: extrassubscriptionsupdate description: Put a subscription object. call: netbox-extras.extrassubscriptionsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrassubscriptionspartialupdate description: Patch a subscription object. call: netbox-extras.extrassubscriptionspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrassubscriptionsdestroy description: Delete a subscription object. call: netbox-extras.extrassubscriptionsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/extras/table-configs name: api-extras-table-configs description: REST surface for api-extras-table-configs. operations: - method: GET name: extrastableconfigslist description: Get a list of table config objects. call: netbox-extras.extrastableconfigslist with: created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex enabled: rest.enabled id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit modified_by_request: rest.modified_by_request name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex object_type: rest.object_type object_type__n: rest.object_type__n object_type_id: rest.object_type_id object_type_id__n: rest.object_type_id__n offset: rest.offset ordering: rest.ordering q: rest.q shared: rest.shared table: rest.table table__empty: rest.table__empty table__ic: rest.table__ic table__ie: rest.table__ie table__iew: rest.table__iew table__iregex: rest.table__iregex table__isw: rest.table__isw table__n: rest.table__n table__nic: rest.table__nic table__nie: rest.table__nie table__niew: rest.table__niew table__nisw: rest.table__nisw table__regex: rest.table__regex updated_by_request: rest.updated_by_request usable: rest.usable user: rest.user user__n: rest.user__n user_id: rest.user_id user_id__n: rest.user_id__n weight: rest.weight weight__empty: rest.weight__empty weight__gt: rest.weight__gt weight__gte: rest.weight__gte weight__lt: rest.weight__lt weight__lte: rest.weight__lte weight__n: rest.weight__n outputParameters: - type: object mapping: $. - method: POST name: extrastableconfigscreate description: Post a list of table config objects. call: netbox-extras.extrastableconfigscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: extrastableconfigsbulkupdate description: Put a list of table config objects. call: netbox-extras.extrastableconfigsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrastableconfigsbulkpartialupdate description: Patch a list of table config objects. call: netbox-extras.extrastableconfigsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrastableconfigsbulkdestroy description: Delete a list of table config objects. call: netbox-extras.extrastableconfigsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/extras/table-configs/{id} name: api-extras-table-configs-id description: REST surface for api-extras-table-configs-id. operations: - method: GET name: extrastableconfigsretrieve description: Get a table config object. call: netbox-extras.extrastableconfigsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: extrastableconfigsupdate description: Put a table config object. call: netbox-extras.extrastableconfigsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrastableconfigspartialupdate description: Patch a table config object. call: netbox-extras.extrastableconfigspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrastableconfigsdestroy description: Delete a table config object. call: netbox-extras.extrastableconfigsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/extras/tagged-objects name: api-extras-tagged-objects description: REST surface for api-extras-tagged-objects. operations: - method: GET name: extrastaggedobjectslist description: Get a list of tagged item objects. call: netbox-extras.extrastaggedobjectslist with: id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n limit: rest.limit object_id: rest.object_id object_id__empty: rest.object_id__empty object_id__gt: rest.object_id__gt object_id__gte: rest.object_id__gte object_id__lt: rest.object_id__lt object_id__lte: rest.object_id__lte object_id__n: rest.object_id__n object_type: rest.object_type object_type__n: rest.object_type__n object_type_id: rest.object_type_id object_type_id__n: rest.object_type_id__n offset: rest.offset ordering: rest.ordering q: rest.q tag: rest.tag tag__n: rest.tag__n tag_id: rest.tag_id tag_id__n: rest.tag_id__n outputParameters: - type: object mapping: $. - path: /v1/api/extras/tagged-objects/{id} name: api-extras-tagged-objects-id description: REST surface for api-extras-tagged-objects-id. operations: - method: GET name: extrastaggedobjectsretrieve description: Get a tagged item object. call: netbox-extras.extrastaggedobjectsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/extras/tags name: api-extras-tags description: REST surface for api-extras-tags. operations: - method: GET name: extrastagslist description: Get a list of tag objects. call: netbox-extras.extrastagslist with: color: rest.color color__empty: rest.color__empty color__ic: rest.color__ic color__ie: rest.color__ie color__iew: rest.color__iew color__iregex: rest.color__iregex color__isw: rest.color__isw color__n: rest.color__n color__nic: rest.color__nic color__nie: rest.color__nie color__niew: rest.color__niew color__nisw: rest.color__nisw color__regex: rest.color__regex content_type: rest.content_type content_type_id: rest.content_type_id created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex for_object_type_id: rest.for_object_type_id id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit modified_by_request: rest.modified_by_request name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex object_types: rest.object_types object_types__n: rest.object_types__n offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n q: rest.q slug: rest.slug slug__empty: rest.slug__empty slug__ic: rest.slug__ic slug__ie: rest.slug__ie slug__iew: rest.slug__iew slug__iregex: rest.slug__iregex slug__isw: rest.slug__isw slug__n: rest.slug__n slug__nic: rest.slug__nic slug__nie: rest.slug__nie slug__niew: rest.slug__niew slug__nisw: rest.slug__nisw slug__regex: rest.slug__regex updated_by_request: rest.updated_by_request weight: rest.weight weight__empty: rest.weight__empty weight__gt: rest.weight__gt weight__gte: rest.weight__gte weight__lt: rest.weight__lt weight__lte: rest.weight__lte weight__n: rest.weight__n outputParameters: - type: object mapping: $. - method: POST name: extrastagscreate description: Post a list of tag objects. call: netbox-extras.extrastagscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: extrastagsbulkupdate description: Put a list of tag objects. call: netbox-extras.extrastagsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrastagsbulkpartialupdate description: Patch a list of tag objects. call: netbox-extras.extrastagsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrastagsbulkdestroy description: Delete a list of tag objects. call: netbox-extras.extrastagsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/extras/tags/{id} name: api-extras-tags-id description: REST surface for api-extras-tags-id. operations: - method: GET name: extrastagsretrieve description: Get a tag object. call: netbox-extras.extrastagsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: extrastagsupdate description: Put a tag object. call: netbox-extras.extrastagsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extrastagspartialupdate description: Patch a tag object. call: netbox-extras.extrastagspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extrastagsdestroy description: Delete a tag object. call: netbox-extras.extrastagsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/extras/webhooks name: api-extras-webhooks description: REST surface for api-extras-webhooks. operations: - method: GET name: extraswebhookslist description: Get a list of webhook objects. call: netbox-extras.extraswebhookslist with: ca_file_path: rest.ca_file_path ca_file_path__empty: rest.ca_file_path__empty ca_file_path__ic: rest.ca_file_path__ic ca_file_path__ie: rest.ca_file_path__ie ca_file_path__iew: rest.ca_file_path__iew ca_file_path__iregex: rest.ca_file_path__iregex ca_file_path__isw: rest.ca_file_path__isw ca_file_path__n: rest.ca_file_path__n ca_file_path__nic: rest.ca_file_path__nic ca_file_path__nie: rest.ca_file_path__nie ca_file_path__niew: rest.ca_file_path__niew ca_file_path__nisw: rest.ca_file_path__nisw ca_file_path__regex: rest.ca_file_path__regex created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex http_content_type: rest.http_content_type http_content_type__empty: rest.http_content_type__empty http_content_type__ic: rest.http_content_type__ic http_content_type__ie: rest.http_content_type__ie http_content_type__iew: rest.http_content_type__iew http_content_type__iregex: rest.http_content_type__iregex http_content_type__isw: rest.http_content_type__isw http_content_type__n: rest.http_content_type__n http_content_type__nic: rest.http_content_type__nic http_content_type__nie: rest.http_content_type__nie http_content_type__niew: rest.http_content_type__niew http_content_type__nisw: rest.http_content_type__nisw http_content_type__regex: rest.http_content_type__regex http_method: rest.http_method http_method__empty: rest.http_method__empty http_method__ic: rest.http_method__ic http_method__ie: rest.http_method__ie http_method__iew: rest.http_method__iew http_method__iregex: rest.http_method__iregex http_method__isw: rest.http_method__isw http_method__n: rest.http_method__n http_method__nic: rest.http_method__nic http_method__nie: rest.http_method__nie http_method__niew: rest.http_method__niew http_method__nisw: rest.http_method__nisw http_method__regex: rest.http_method__regex id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit modified_by_request: rest.modified_by_request name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n payload_url: rest.payload_url q: rest.q secret: rest.secret secret__empty: rest.secret__empty secret__ic: rest.secret__ic secret__ie: rest.secret__ie secret__iew: rest.secret__iew secret__iregex: rest.secret__iregex secret__isw: rest.secret__isw secret__n: rest.secret__n secret__nic: rest.secret__nic secret__nie: rest.secret__nie secret__niew: rest.secret__niew secret__nisw: rest.secret__nisw secret__regex: rest.secret__regex ssl_verification: rest.ssl_verification tag: rest.tag tag__n: rest.tag__n tag_id: rest.tag_id tag_id__n: rest.tag_id__n updated_by_request: rest.updated_by_request outputParameters: - type: object mapping: $. - method: POST name: extraswebhookscreate description: Post a list of webhook objects. call: netbox-extras.extraswebhookscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: extraswebhooksbulkupdate description: Put a list of webhook objects. call: netbox-extras.extraswebhooksbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extraswebhooksbulkpartialupdate description: Patch a list of webhook objects. call: netbox-extras.extraswebhooksbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extraswebhooksbulkdestroy description: Delete a list of webhook objects. call: netbox-extras.extraswebhooksbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/extras/webhooks/{id} name: api-extras-webhooks-id description: REST surface for api-extras-webhooks-id. operations: - method: GET name: extraswebhooksretrieve description: Get a webhook object. call: netbox-extras.extraswebhooksretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: extraswebhooksupdate description: Put a webhook object. call: netbox-extras.extraswebhooksupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: extraswebhookspartialupdate description: Patch a webhook object. call: netbox-extras.extraswebhookspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: extraswebhooksdestroy description: Delete a webhook object. call: netbox-extras.extraswebhooksdestroy with: id: rest.id outputParameters: - type: object mapping: $. - type: mcp namespace: netbox-extras-mcp port: 9090 transport: http description: MCP adapter for NetBox REST API — extras. One tool per consumed operation, routed inline through this capability's consumes block. tools: - name: get-list-bookmark-objects description: Get a list of bookmark objects. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrasbookmarkslist with: created: tools.created id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n limit: tools.limit object_id: tools.object_id object_id__empty: tools.object_id__empty object_id__gt: tools.object_id__gt object_id__gte: tools.object_id__gte object_id__lt: tools.object_id__lt object_id__lte: tools.object_id__lte object_id__n: tools.object_id__n object_type: tools.object_type object_type__n: tools.object_type__n object_type_id: tools.object_type_id object_type_id__empty: tools.object_type_id__empty object_type_id__gt: tools.object_type_id__gt object_type_id__gte: tools.object_type_id__gte object_type_id__lt: tools.object_type_id__lt object_type_id__lte: tools.object_type_id__lte object_type_id__n: tools.object_type_id__n offset: tools.offset ordering: tools.ordering user: tools.user user__n: tools.user__n user_id: tools.user_id user_id__n: tools.user_id__n outputParameters: - type: object mapping: $. - name: post-list-bookmark-objects description: Post a list of bookmark objects. hints: readOnly: true destructive: false idempotent: false call: netbox-extras.extrasbookmarkscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-bookmark-objects description: Put a list of bookmark objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasbookmarksbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-bookmark-objects description: Patch a list of bookmark objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasbookmarksbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-bookmark-objects description: Delete a list of bookmark objects. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrasbookmarksbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-bookmark-object description: Get a bookmark object. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrasbookmarksretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-bookmark-object description: Put a bookmark object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasbookmarksupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-bookmark-object description: Patch a bookmark object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasbookmarkspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-bookmark-object description: Delete a bookmark object. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrasbookmarksdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-config-context-profile description: Get a list of config context profile objects. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrasconfigcontextprofileslist with: auto_sync_enabled: tools.auto_sync_enabled created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request data_file_id: tools.data_file_id data_file_id__n: tools.data_file_id__n data_source_id: tools.data_source_id data_source_id__n: tools.data_source_id__n data_synced: tools.data_synced data_synced__empty: tools.data_synced__empty data_synced__gt: tools.data_synced__gt data_synced__gte: tools.data_synced__gte data_synced__lt: tools.data_synced__lt data_synced__lte: tools.data_synced__lte data_synced__n: tools.data_synced__n description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit modified_by_request: tools.modified_by_request name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n q: tools.q tag: tools.tag tag__n: tools.tag__n tag_id: tools.tag_id tag_id__n: tools.tag_id__n updated_by_request: tools.updated_by_request outputParameters: - type: object mapping: $. - name: post-list-config-context-profile description: Post a list of config context profile objects. hints: readOnly: true destructive: false idempotent: false call: netbox-extras.extrasconfigcontextprofilescreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-config-context-profile description: Put a list of config context profile objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasconfigcontextprofilesbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-config-context-profile description: Patch a list of config context profile objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasconfigcontextprofilesbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-config-context-profile description: Delete a list of config context profile objects. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrasconfigcontextprofilesbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-config-context-profile-object description: Get a config context profile object. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrasconfigcontextprofilesretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-config-context-profile-object description: Put a config context profile object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasconfigcontextprofilesupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-config-context-profile-object description: Patch a config context profile object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasconfigcontextprofilespartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-config-context-profile-object description: Delete a config context profile object. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrasconfigcontextprofilesdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: provide-sync-api-endpoint-synchronize description: Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any). hints: readOnly: false destructive: false idempotent: false call: netbox-extras.extrasconfigcontextprofilessynccreate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: get-list-config-context-objects description: Get a list of config context objects. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrasconfigcontextslist with: auto_sync_enabled: tools.auto_sync_enabled cluster_group: tools.cluster_group cluster_group__n: tools.cluster_group__n cluster_group_id: tools.cluster_group_id cluster_group_id__n: tools.cluster_group_id__n cluster_id: tools.cluster_id cluster_id__n: tools.cluster_id__n cluster_type: tools.cluster_type cluster_type__n: tools.cluster_type__n cluster_type_id: tools.cluster_type_id cluster_type_id__n: tools.cluster_type_id__n created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request data_file_id: tools.data_file_id data_file_id__n: tools.data_file_id__n data_source_id: tools.data_source_id data_source_id__n: tools.data_source_id__n data_synced: tools.data_synced data_synced__empty: tools.data_synced__empty data_synced__gt: tools.data_synced__gt data_synced__gte: tools.data_synced__gte data_synced__lt: tools.data_synced__lt data_synced__lte: tools.data_synced__lte data_synced__n: tools.data_synced__n description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex device_role: tools.device_role device_role__n: tools.device_role__n device_role_id: tools.device_role_id device_role_id__n: tools.device_role_id__n device_type_id: tools.device_type_id device_type_id__n: tools.device_type_id__n id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n is_active: tools.is_active last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit location: tools.location location__n: tools.location__n location_id: tools.location_id location_id__n: tools.location_id__n modified_by_request: tools.modified_by_request name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n platform: tools.platform platform__n: tools.platform__n platform_id: tools.platform_id platform_id__n: tools.platform_id__n profile: tools.profile profile__n: tools.profile__n profile_id: tools.profile_id profile_id__n: tools.profile_id__n q: tools.q region: tools.region region__n: tools.region__n region_id: tools.region_id region_id__n: tools.region_id__n site: tools.site site__n: tools.site__n site_group: tools.site_group site_group__n: tools.site_group__n site_group_id: tools.site_group_id site_group_id__n: tools.site_group_id__n site_id: tools.site_id site_id__n: tools.site_id__n tag: tools.tag tag__n: tools.tag__n tag_id: tools.tag_id tag_id__n: tools.tag_id__n tenant: tools.tenant tenant__n: tools.tenant__n tenant_group: tools.tenant_group tenant_group__n: tools.tenant_group__n tenant_group_id: tools.tenant_group_id tenant_group_id__n: tools.tenant_group_id__n tenant_id: tools.tenant_id tenant_id__n: tools.tenant_id__n updated_by_request: tools.updated_by_request weight: tools.weight weight__empty: tools.weight__empty weight__gt: tools.weight__gt weight__gte: tools.weight__gte weight__lt: tools.weight__lt weight__lte: tools.weight__lte weight__n: tools.weight__n outputParameters: - type: object mapping: $. - name: post-list-config-context-objects description: Post a list of config context objects. hints: readOnly: true destructive: false idempotent: false call: netbox-extras.extrasconfigcontextscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-config-context-objects description: Put a list of config context objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasconfigcontextsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-config-context-objects description: Patch a list of config context objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasconfigcontextsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-config-context-objects description: Delete a list of config context objects. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrasconfigcontextsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-config-context-object description: Get a config context object. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrasconfigcontextsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-config-context-object description: Put a config context object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasconfigcontextsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-config-context-object description: Patch a config context object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasconfigcontextspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-config-context-object description: Delete a config context object. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrasconfigcontextsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: provide-sync-api-endpoint-synchronize-2 description: Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any). hints: readOnly: false destructive: false idempotent: false call: netbox-extras.extrasconfigcontextssynccreate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: get-list-config-template-objects description: Get a list of config template objects. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrasconfigtemplateslist with: as_attachment: tools.as_attachment auto_sync_enabled: tools.auto_sync_enabled created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request data_file_id: tools.data_file_id data_file_id__n: tools.data_file_id__n data_source_id: tools.data_source_id data_source_id__n: tools.data_source_id__n data_synced: tools.data_synced data_synced__empty: tools.data_synced__empty data_synced__gt: tools.data_synced__gt data_synced__gte: tools.data_synced__gte data_synced__lt: tools.data_synced__lt data_synced__lte: tools.data_synced__lte data_synced__n: tools.data_synced__n description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex file_extension: tools.file_extension file_extension__empty: tools.file_extension__empty file_extension__ic: tools.file_extension__ic file_extension__ie: tools.file_extension__ie file_extension__iew: tools.file_extension__iew file_extension__iregex: tools.file_extension__iregex file_extension__isw: tools.file_extension__isw file_extension__n: tools.file_extension__n file_extension__nic: tools.file_extension__nic file_extension__nie: tools.file_extension__nie file_extension__niew: tools.file_extension__niew file_extension__nisw: tools.file_extension__nisw file_extension__regex: tools.file_extension__regex file_name: tools.file_name file_name__empty: tools.file_name__empty file_name__ic: tools.file_name__ic file_name__ie: tools.file_name__ie file_name__iew: tools.file_name__iew file_name__iregex: tools.file_name__iregex file_name__isw: tools.file_name__isw file_name__n: tools.file_name__n file_name__nic: tools.file_name__nic file_name__nie: tools.file_name__nie file_name__niew: tools.file_name__niew file_name__nisw: tools.file_name__nisw file_name__regex: tools.file_name__regex id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit mime_type: tools.mime_type mime_type__empty: tools.mime_type__empty mime_type__ic: tools.mime_type__ic mime_type__ie: tools.mime_type__ie mime_type__iew: tools.mime_type__iew mime_type__iregex: tools.mime_type__iregex mime_type__isw: tools.mime_type__isw mime_type__n: tools.mime_type__n mime_type__nic: tools.mime_type__nic mime_type__nie: tools.mime_type__nie mime_type__niew: tools.mime_type__niew mime_type__nisw: tools.mime_type__nisw mime_type__regex: tools.mime_type__regex modified_by_request: tools.modified_by_request name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n q: tools.q tag: tools.tag tag__n: tools.tag__n tag_id: tools.tag_id tag_id__n: tools.tag_id__n updated_by_request: tools.updated_by_request outputParameters: - type: object mapping: $. - name: post-list-config-template-objects description: Post a list of config template objects. hints: readOnly: true destructive: false idempotent: false call: netbox-extras.extrasconfigtemplatescreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-config-template-objects description: Put a list of config template objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasconfigtemplatesbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-config-template-objects description: Patch a list of config template objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasconfigtemplatesbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-config-template-objects description: Delete a list of config template objects. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrasconfigtemplatesbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-config-template-object description: Get a config template object. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrasconfigtemplatesretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-config-template-object description: Put a config template object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasconfigtemplatesupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-config-template-object description: Patch a config template object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasconfigtemplatespartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-config-template-object description: Delete a config template object. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrasconfigtemplatesdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: render-configtemplate-using-context-data description: Render a ConfigTemplate using the context data provided (if any). If the client requests "text/plain" data, hints: readOnly: false destructive: false idempotent: false call: netbox-extras.extrasconfigtemplatesrendercreate with: format: tools.format id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: provide-sync-api-endpoint-synchronize-3 description: Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any). hints: readOnly: false destructive: false idempotent: false call: netbox-extras.extrasconfigtemplatessynccreate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: get-list-custom-field-choice description: Get a list of custom field choice set objects. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrascustomfieldchoicesetslist with: base_choices: tools.base_choices base_choices__empty: tools.base_choices__empty base_choices__ic: tools.base_choices__ic base_choices__ie: tools.base_choices__ie base_choices__iew: tools.base_choices__iew base_choices__iregex: tools.base_choices__iregex base_choices__isw: tools.base_choices__isw base_choices__n: tools.base_choices__n base_choices__nic: tools.base_choices__nic base_choices__nie: tools.base_choices__nie base_choices__niew: tools.base_choices__niew base_choices__nisw: tools.base_choices__nisw base_choices__regex: tools.base_choices__regex choice: tools.choice created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit modified_by_request: tools.modified_by_request name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex offset: tools.offset order_alphabetically: tools.order_alphabetically ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n q: tools.q updated_by_request: tools.updated_by_request outputParameters: - type: object mapping: $. - name: post-list-custom-field-choice description: Post a list of custom field choice set objects. hints: readOnly: true destructive: false idempotent: false call: netbox-extras.extrascustomfieldchoicesetscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-custom-field-choice description: Put a list of custom field choice set objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrascustomfieldchoicesetsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-custom-field-choice description: Patch a list of custom field choice set objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrascustomfieldchoicesetsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-custom-field-choice description: Delete a list of custom field choice set objects. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrascustomfieldchoicesetsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-custom-field-choice-set description: Get a custom field choice set object. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrascustomfieldchoicesetsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-custom-field-choice-set description: Put a custom field choice set object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrascustomfieldchoicesetsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-custom-field-choice-set description: Patch a custom field choice set object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrascustomfieldchoicesetspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-custom-field-choice-set description: Delete a custom field choice set object. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrascustomfieldchoicesetsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: provides-endpoint-iterate-through-each description: Provides an endpoint to iterate through each choice in a set. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrascustomfieldchoicesetschoicesretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-custom-field-objects description: Get a list of custom field objects. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrascustomfieldslist with: choice_set: tools.choice_set choice_set__n: tools.choice_set__n choice_set_id: tools.choice_set_id choice_set_id__n: tools.choice_set_id__n created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex filter_logic: tools.filter_logic filter_logic__empty: tools.filter_logic__empty filter_logic__ic: tools.filter_logic__ic filter_logic__ie: tools.filter_logic__ie filter_logic__iew: tools.filter_logic__iew filter_logic__iregex: tools.filter_logic__iregex filter_logic__isw: tools.filter_logic__isw filter_logic__n: tools.filter_logic__n filter_logic__nic: tools.filter_logic__nic filter_logic__nie: tools.filter_logic__nie filter_logic__niew: tools.filter_logic__niew filter_logic__nisw: tools.filter_logic__nisw filter_logic__regex: tools.filter_logic__regex group_name: tools.group_name group_name__empty: tools.group_name__empty group_name__ic: tools.group_name__ic group_name__ie: tools.group_name__ie group_name__iew: tools.group_name__iew group_name__iregex: tools.group_name__iregex group_name__isw: tools.group_name__isw group_name__n: tools.group_name__n group_name__nic: tools.group_name__nic group_name__nie: tools.group_name__nie group_name__niew: tools.group_name__niew group_name__nisw: tools.group_name__nisw group_name__regex: tools.group_name__regex id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n is_cloneable: tools.is_cloneable label: tools.label label__empty: tools.label__empty label__ic: tools.label__ic label__ie: tools.label__ie label__iew: tools.label__iew label__iregex: tools.label__iregex label__isw: tools.label__isw label__n: tools.label__n label__nic: tools.label__nic label__nie: tools.label__nie label__niew: tools.label__niew label__nisw: tools.label__nisw label__regex: tools.label__regex last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit modified_by_request: tools.modified_by_request name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex object_type: tools.object_type object_type__ic: tools.object_type__ic object_type__ie: tools.object_type__ie object_type__iew: tools.object_type__iew object_type__iregex: tools.object_type__iregex object_type__isw: tools.object_type__isw object_type__n: tools.object_type__n object_type__nic: tools.object_type__nic object_type__nie: tools.object_type__nie object_type__niew: tools.object_type__niew object_type__nisw: tools.object_type__nisw object_type__regex: tools.object_type__regex object_type_id: tools.object_type_id object_type_id__n: tools.object_type_id__n offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n q: tools.q related_object_type: tools.related_object_type related_object_type__n: tools.related_object_type__n related_object_type_id: tools.related_object_type_id related_object_type_id__n: tools.related_object_type_id__n required: tools.required search_weight: tools.search_weight search_weight__empty: tools.search_weight__empty search_weight__gt: tools.search_weight__gt search_weight__gte: tools.search_weight__gte search_weight__lt: tools.search_weight__lt search_weight__lte: tools.search_weight__lte search_weight__n: tools.search_weight__n type: tools.type type__empty: tools.type__empty type__ic: tools.type__ic type__ie: tools.type__ie type__iew: tools.type__iew type__iregex: tools.type__iregex type__isw: tools.type__isw type__n: tools.type__n type__nic: tools.type__nic type__nie: tools.type__nie type__niew: tools.type__niew type__nisw: tools.type__nisw type__regex: tools.type__regex ui_editable: tools.ui_editable ui_editable__empty: tools.ui_editable__empty ui_editable__ic: tools.ui_editable__ic ui_editable__ie: tools.ui_editable__ie ui_editable__iew: tools.ui_editable__iew ui_editable__iregex: tools.ui_editable__iregex ui_editable__isw: tools.ui_editable__isw ui_editable__n: tools.ui_editable__n ui_editable__nic: tools.ui_editable__nic ui_editable__nie: tools.ui_editable__nie ui_editable__niew: tools.ui_editable__niew ui_editable__nisw: tools.ui_editable__nisw ui_editable__regex: tools.ui_editable__regex ui_visible: tools.ui_visible ui_visible__empty: tools.ui_visible__empty ui_visible__ic: tools.ui_visible__ic ui_visible__ie: tools.ui_visible__ie ui_visible__iew: tools.ui_visible__iew ui_visible__iregex: tools.ui_visible__iregex ui_visible__isw: tools.ui_visible__isw ui_visible__n: tools.ui_visible__n ui_visible__nic: tools.ui_visible__nic ui_visible__nie: tools.ui_visible__nie ui_visible__niew: tools.ui_visible__niew ui_visible__nisw: tools.ui_visible__nisw ui_visible__regex: tools.ui_visible__regex unique: tools.unique updated_by_request: tools.updated_by_request validation_maximum: tools.validation_maximum validation_maximum__empty: tools.validation_maximum__empty validation_maximum__gt: tools.validation_maximum__gt validation_maximum__gte: tools.validation_maximum__gte validation_maximum__lt: tools.validation_maximum__lt validation_maximum__lte: tools.validation_maximum__lte validation_maximum__n: tools.validation_maximum__n validation_minimum: tools.validation_minimum validation_minimum__empty: tools.validation_minimum__empty validation_minimum__gt: tools.validation_minimum__gt validation_minimum__gte: tools.validation_minimum__gte validation_minimum__lt: tools.validation_minimum__lt validation_minimum__lte: tools.validation_minimum__lte validation_minimum__n: tools.validation_minimum__n validation_regex: tools.validation_regex validation_regex__empty: tools.validation_regex__empty validation_regex__ic: tools.validation_regex__ic validation_regex__ie: tools.validation_regex__ie validation_regex__iew: tools.validation_regex__iew validation_regex__iregex: tools.validation_regex__iregex validation_regex__isw: tools.validation_regex__isw validation_regex__n: tools.validation_regex__n validation_regex__nic: tools.validation_regex__nic validation_regex__nie: tools.validation_regex__nie validation_regex__niew: tools.validation_regex__niew validation_regex__nisw: tools.validation_regex__nisw validation_regex__regex: tools.validation_regex__regex weight: tools.weight weight__empty: tools.weight__empty weight__gt: tools.weight__gt weight__gte: tools.weight__gte weight__lt: tools.weight__lt weight__lte: tools.weight__lte weight__n: tools.weight__n outputParameters: - type: object mapping: $. - name: post-list-custom-field-objects description: Post a list of custom field objects. hints: readOnly: true destructive: false idempotent: false call: netbox-extras.extrascustomfieldscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-custom-field-objects description: Put a list of custom field objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrascustomfieldsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-custom-field-objects description: Patch a list of custom field objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrascustomfieldsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-custom-field-objects description: Delete a list of custom field objects. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrascustomfieldsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-custom-field-object description: Get a custom field object. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrascustomfieldsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-custom-field-object description: Put a custom field object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrascustomfieldsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-custom-field-object description: Patch a custom field object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrascustomfieldspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-custom-field-object description: Delete a custom field object. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrascustomfieldsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-custom-link-objects description: Get a list of custom link objects. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrascustomlinkslist with: button_class: tools.button_class button_class__empty: tools.button_class__empty button_class__ic: tools.button_class__ic button_class__ie: tools.button_class__ie button_class__iew: tools.button_class__iew button_class__iregex: tools.button_class__iregex button_class__isw: tools.button_class__isw button_class__n: tools.button_class__n button_class__nic: tools.button_class__nic button_class__nie: tools.button_class__nie button_class__niew: tools.button_class__niew button_class__nisw: tools.button_class__nisw button_class__regex: tools.button_class__regex created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request enabled: tools.enabled group_name: tools.group_name group_name__empty: tools.group_name__empty group_name__ic: tools.group_name__ic group_name__ie: tools.group_name__ie group_name__iew: tools.group_name__iew group_name__iregex: tools.group_name__iregex group_name__isw: tools.group_name__isw group_name__n: tools.group_name__n group_name__nic: tools.group_name__nic group_name__nie: tools.group_name__nie group_name__niew: tools.group_name__niew group_name__nisw: tools.group_name__nisw group_name__regex: tools.group_name__regex id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit link_text: tools.link_text link_text__ic: tools.link_text__ic link_text__ie: tools.link_text__ie link_text__iew: tools.link_text__iew link_text__iregex: tools.link_text__iregex link_text__isw: tools.link_text__isw link_text__n: tools.link_text__n link_text__nic: tools.link_text__nic link_text__nie: tools.link_text__nie link_text__niew: tools.link_text__niew link_text__nisw: tools.link_text__nisw link_text__regex: tools.link_text__regex link_url: tools.link_url link_url__ic: tools.link_url__ic link_url__ie: tools.link_url__ie link_url__iew: tools.link_url__iew link_url__iregex: tools.link_url__iregex link_url__isw: tools.link_url__isw link_url__n: tools.link_url__n link_url__nic: tools.link_url__nic link_url__nie: tools.link_url__nie link_url__niew: tools.link_url__niew link_url__nisw: tools.link_url__nisw link_url__regex: tools.link_url__regex modified_by_request: tools.modified_by_request name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex new_window: tools.new_window object_type: tools.object_type object_type__ic: tools.object_type__ic object_type__ie: tools.object_type__ie object_type__iew: tools.object_type__iew object_type__iregex: tools.object_type__iregex object_type__isw: tools.object_type__isw object_type__n: tools.object_type__n object_type__nic: tools.object_type__nic object_type__nie: tools.object_type__nie object_type__niew: tools.object_type__niew object_type__nisw: tools.object_type__nisw object_type__regex: tools.object_type__regex object_type_id: tools.object_type_id object_type_id__n: tools.object_type_id__n offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n q: tools.q updated_by_request: tools.updated_by_request weight: tools.weight weight__empty: tools.weight__empty weight__gt: tools.weight__gt weight__gte: tools.weight__gte weight__lt: tools.weight__lt weight__lte: tools.weight__lte weight__n: tools.weight__n outputParameters: - type: object mapping: $. - name: post-list-custom-link-objects description: Post a list of custom link objects. hints: readOnly: true destructive: false idempotent: false call: netbox-extras.extrascustomlinkscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-custom-link-objects description: Put a list of custom link objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrascustomlinksbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-custom-link-objects description: Patch a list of custom link objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrascustomlinksbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-custom-link-objects description: Delete a list of custom link objects. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrascustomlinksbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-custom-link-object description: Get a custom link object. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrascustomlinksretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-custom-link-object description: Put a custom link object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrascustomlinksupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-custom-link-object description: Patch a custom link object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrascustomlinkspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-custom-link-object description: Delete a custom link object. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrascustomlinksdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-dashboard-objects description: Get a list of dashboard objects. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrasdashboardretrieve outputParameters: - type: object mapping: $. - name: put-list-dashboard-objects description: Put a list of dashboard objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasdashboardupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-dashboard-objects description: Patch a list of dashboard objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasdashboardpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-dashboard-objects description: Delete a list of dashboard objects. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrasdashboarddestroy outputParameters: - type: object mapping: $. - name: get-list-event-rule-objects description: Get a list of event rule objects. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extraseventruleslist with: action_object_id: tools.action_object_id action_object_id__empty: tools.action_object_id__empty action_object_id__gt: tools.action_object_id__gt action_object_id__gte: tools.action_object_id__gte action_object_id__lt: tools.action_object_id__lt action_object_id__lte: tools.action_object_id__lte action_object_id__n: tools.action_object_id__n action_object_type: tools.action_object_type action_object_type__n: tools.action_object_type__n action_type: tools.action_type action_type__empty: tools.action_type__empty action_type__ic: tools.action_type__ic action_type__ie: tools.action_type__ie action_type__iew: tools.action_type__iew action_type__iregex: tools.action_type__iregex action_type__isw: tools.action_type__isw action_type__n: tools.action_type__n action_type__nic: tools.action_type__nic action_type__nie: tools.action_type__nie action_type__niew: tools.action_type__niew action_type__nisw: tools.action_type__nisw action_type__regex: tools.action_type__regex created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex enabled: tools.enabled event_type: tools.event_type id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit modified_by_request: tools.modified_by_request name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex object_type: tools.object_type object_type__ic: tools.object_type__ic object_type__ie: tools.object_type__ie object_type__iew: tools.object_type__iew object_type__iregex: tools.object_type__iregex object_type__isw: tools.object_type__isw object_type__n: tools.object_type__n object_type__nic: tools.object_type__nic object_type__nie: tools.object_type__nie object_type__niew: tools.object_type__niew object_type__nisw: tools.object_type__nisw object_type__regex: tools.object_type__regex object_type_id: tools.object_type_id object_type_id__n: tools.object_type_id__n offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n q: tools.q tag: tools.tag tag__n: tools.tag__n tag_id: tools.tag_id tag_id__n: tools.tag_id__n updated_by_request: tools.updated_by_request outputParameters: - type: object mapping: $. - name: post-list-event-rule-objects description: Post a list of event rule objects. hints: readOnly: true destructive: false idempotent: false call: netbox-extras.extraseventrulescreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-event-rule-objects description: Put a list of event rule objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extraseventrulesbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-event-rule-objects description: Patch a list of event rule objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extraseventrulesbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-event-rule-objects description: Delete a list of event rule objects. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extraseventrulesbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-event-rule-object description: Get a event rule object. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extraseventrulesretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-event-rule-object description: Put a event rule object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extraseventrulesupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-event-rule-object description: Patch a event rule object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extraseventrulespartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-event-rule-object description: Delete a event rule object. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extraseventrulesdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-export-template-objects description: Get a list of export template objects. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrasexporttemplateslist with: as_attachment: tools.as_attachment auto_sync_enabled: tools.auto_sync_enabled created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request data_file_id: tools.data_file_id data_file_id__n: tools.data_file_id__n data_source_id: tools.data_source_id data_source_id__n: tools.data_source_id__n data_synced: tools.data_synced data_synced__empty: tools.data_synced__empty data_synced__gt: tools.data_synced__gt data_synced__gte: tools.data_synced__gte data_synced__lt: tools.data_synced__lt data_synced__lte: tools.data_synced__lte data_synced__n: tools.data_synced__n description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex file_extension: tools.file_extension file_extension__empty: tools.file_extension__empty file_extension__ic: tools.file_extension__ic file_extension__ie: tools.file_extension__ie file_extension__iew: tools.file_extension__iew file_extension__iregex: tools.file_extension__iregex file_extension__isw: tools.file_extension__isw file_extension__n: tools.file_extension__n file_extension__nic: tools.file_extension__nic file_extension__nie: tools.file_extension__nie file_extension__niew: tools.file_extension__niew file_extension__nisw: tools.file_extension__nisw file_extension__regex: tools.file_extension__regex file_name: tools.file_name file_name__empty: tools.file_name__empty file_name__ic: tools.file_name__ic file_name__ie: tools.file_name__ie file_name__iew: tools.file_name__iew file_name__iregex: tools.file_name__iregex file_name__isw: tools.file_name__isw file_name__n: tools.file_name__n file_name__nic: tools.file_name__nic file_name__nie: tools.file_name__nie file_name__niew: tools.file_name__niew file_name__nisw: tools.file_name__nisw file_name__regex: tools.file_name__regex id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit mime_type: tools.mime_type mime_type__empty: tools.mime_type__empty mime_type__ic: tools.mime_type__ic mime_type__ie: tools.mime_type__ie mime_type__iew: tools.mime_type__iew mime_type__iregex: tools.mime_type__iregex mime_type__isw: tools.mime_type__isw mime_type__n: tools.mime_type__n mime_type__nic: tools.mime_type__nic mime_type__nie: tools.mime_type__nie mime_type__niew: tools.mime_type__niew mime_type__nisw: tools.mime_type__nisw mime_type__regex: tools.mime_type__regex modified_by_request: tools.modified_by_request name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex object_type: tools.object_type object_type__ic: tools.object_type__ic object_type__ie: tools.object_type__ie object_type__iew: tools.object_type__iew object_type__iregex: tools.object_type__iregex object_type__isw: tools.object_type__isw object_type__n: tools.object_type__n object_type__nic: tools.object_type__nic object_type__nie: tools.object_type__nie object_type__niew: tools.object_type__niew object_type__nisw: tools.object_type__nisw object_type__regex: tools.object_type__regex object_type_id: tools.object_type_id object_type_id__n: tools.object_type_id__n offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n q: tools.q updated_by_request: tools.updated_by_request outputParameters: - type: object mapping: $. - name: post-list-export-template-objects description: Post a list of export template objects. hints: readOnly: true destructive: false idempotent: false call: netbox-extras.extrasexporttemplatescreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-export-template-objects description: Put a list of export template objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasexporttemplatesbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-export-template-objects description: Patch a list of export template objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasexporttemplatesbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-export-template-objects description: Delete a list of export template objects. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrasexporttemplatesbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-export-template-object description: Get a export template object. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrasexporttemplatesretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-export-template-object description: Put a export template object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasexporttemplatesupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-export-template-object description: Patch a export template object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasexporttemplatespartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-export-template-object description: Delete a export template object. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrasexporttemplatesdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: provide-sync-api-endpoint-synchronize-4 description: Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any). hints: readOnly: false destructive: false idempotent: false call: netbox-extras.extrasexporttemplatessynccreate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: get-list-image-attachment-objects description: Get a list of image attachment objects. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrasimageattachmentslist with: created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n image_height: tools.image_height image_height__empty: tools.image_height__empty image_height__gt: tools.image_height__gt image_height__gte: tools.image_height__gte image_height__lt: tools.image_height__lt image_height__lte: tools.image_height__lte image_height__n: tools.image_height__n image_width: tools.image_width image_width__empty: tools.image_width__empty image_width__gt: tools.image_width__gt image_width__gte: tools.image_width__gte image_width__lt: tools.image_width__lt image_width__lte: tools.image_width__lte image_width__n: tools.image_width__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit modified_by_request: tools.modified_by_request name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex object_id: tools.object_id object_id__empty: tools.object_id__empty object_id__gt: tools.object_id__gt object_id__gte: tools.object_id__gte object_id__lt: tools.object_id__lt object_id__lte: tools.object_id__lte object_id__n: tools.object_id__n object_type: tools.object_type object_type__n: tools.object_type__n object_type_id: tools.object_type_id object_type_id__n: tools.object_type_id__n offset: tools.offset ordering: tools.ordering q: tools.q updated_by_request: tools.updated_by_request outputParameters: - type: object mapping: $. - name: post-list-image-attachment-objects description: Post a list of image attachment objects. hints: readOnly: true destructive: false idempotent: false call: netbox-extras.extrasimageattachmentscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-image-attachment-objects description: Put a list of image attachment objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasimageattachmentsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-image-attachment-objects description: Patch a list of image attachment objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasimageattachmentsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-image-attachment-objects description: Delete a list of image attachment objects. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrasimageattachmentsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-image-attachment-object description: Get a image attachment object. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrasimageattachmentsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-image-attachment-object description: Put a image attachment object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasimageattachmentsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-image-attachment-object description: Patch a image attachment object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasimageattachmentspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-image-attachment-object description: Delete a image attachment object. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrasimageattachmentsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-journal-entry-objects description: Get a list of journal entry objects. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrasjournalentrieslist with: assigned_object_id: tools.assigned_object_id assigned_object_id__empty: tools.assigned_object_id__empty assigned_object_id__gt: tools.assigned_object_id__gt assigned_object_id__gte: tools.assigned_object_id__gte assigned_object_id__lt: tools.assigned_object_id__lt assigned_object_id__lte: tools.assigned_object_id__lte assigned_object_id__n: tools.assigned_object_id__n assigned_object_type: tools.assigned_object_type assigned_object_type__n: tools.assigned_object_type__n assigned_object_type_id: tools.assigned_object_type_id assigned_object_type_id__n: tools.assigned_object_type_id__n created_after: tools.created_after created_before: tools.created_before created_by: tools.created_by created_by__n: tools.created_by__n created_by_id: tools.created_by_id created_by_id__n: tools.created_by_id__n created_by_request: tools.created_by_request id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n kind: tools.kind kind__empty: tools.kind__empty kind__ic: tools.kind__ic kind__ie: tools.kind__ie kind__iew: tools.kind__iew kind__iregex: tools.kind__iregex kind__isw: tools.kind__isw kind__n: tools.kind__n kind__nic: tools.kind__nic kind__nie: tools.kind__nie kind__niew: tools.kind__niew kind__nisw: tools.kind__nisw kind__regex: tools.kind__regex last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit modified_by_request: tools.modified_by_request offset: tools.offset ordering: tools.ordering q: tools.q tag: tools.tag tag__n: tools.tag__n tag_id: tools.tag_id tag_id__n: tools.tag_id__n updated_by_request: tools.updated_by_request outputParameters: - type: object mapping: $. - name: post-list-journal-entry-objects description: Post a list of journal entry objects. hints: readOnly: true destructive: false idempotent: false call: netbox-extras.extrasjournalentriescreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-journal-entry-objects description: Put a list of journal entry objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasjournalentriesbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-journal-entry-objects description: Patch a list of journal entry objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasjournalentriesbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-journal-entry-objects description: Delete a list of journal entry objects. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrasjournalentriesbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-journal-entry-object description: Get a journal entry object. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrasjournalentriesretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-journal-entry-object description: Put a journal entry object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasjournalentriesupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-journal-entry-object description: Patch a journal entry object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasjournalentriespartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-journal-entry-object description: Delete a journal entry object. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrasjournalentriesdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-notification-group-objects description: Get a list of notification group objects. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrasnotificationgroupslist with: limit: tools.limit offset: tools.offset ordering: tools.ordering outputParameters: - type: object mapping: $. - name: post-list-notification-group-objects description: Post a list of notification group objects. hints: readOnly: true destructive: false idempotent: false call: netbox-extras.extrasnotificationgroupscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-notification-group-objects description: Put a list of notification group objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasnotificationgroupsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-notification-group-objects description: Patch a list of notification group objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasnotificationgroupsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-notification-group-objects description: Delete a list of notification group objects. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrasnotificationgroupsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-notification-group-object description: Get a notification group object. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrasnotificationgroupsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-notification-group-object description: Put a notification group object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasnotificationgroupsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-notification-group-object description: Patch a notification group object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasnotificationgroupspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-notification-group-object description: Delete a notification group object. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrasnotificationgroupsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-notification-objects description: Get a list of notification objects. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrasnotificationslist with: limit: tools.limit offset: tools.offset ordering: tools.ordering outputParameters: - type: object mapping: $. - name: post-list-notification-objects description: Post a list of notification objects. hints: readOnly: true destructive: false idempotent: false call: netbox-extras.extrasnotificationscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-notification-objects description: Put a list of notification objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasnotificationsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-notification-objects description: Patch a list of notification objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasnotificationsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-notification-objects description: Delete a list of notification objects. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrasnotificationsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-notification-object description: Get a notification object. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrasnotificationsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-notification-object description: Put a notification object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasnotificationsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-notification-object description: Patch a notification object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasnotificationspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-notification-object description: Delete a notification object. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrasnotificationsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-saved-filter-objects description: Get a list of saved filter objects. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrassavedfilterslist with: created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex enabled: tools.enabled id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit modified_by_request: tools.modified_by_request name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex object_type: tools.object_type object_type__ic: tools.object_type__ic object_type__ie: tools.object_type__ie object_type__iew: tools.object_type__iew object_type__iregex: tools.object_type__iregex object_type__isw: tools.object_type__isw object_type__n: tools.object_type__n object_type__nic: tools.object_type__nic object_type__nie: tools.object_type__nie object_type__niew: tools.object_type__niew object_type__nisw: tools.object_type__nisw object_type__regex: tools.object_type__regex object_type_id: tools.object_type_id object_type_id__n: tools.object_type_id__n offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n q: tools.q shared: tools.shared slug: tools.slug slug__empty: tools.slug__empty slug__ic: tools.slug__ic slug__ie: tools.slug__ie slug__iew: tools.slug__iew slug__iregex: tools.slug__iregex slug__isw: tools.slug__isw slug__n: tools.slug__n slug__nic: tools.slug__nic slug__nie: tools.slug__nie slug__niew: tools.slug__niew slug__nisw: tools.slug__nisw slug__regex: tools.slug__regex updated_by_request: tools.updated_by_request usable: tools.usable user: tools.user user__n: tools.user__n user_id: tools.user_id user_id__n: tools.user_id__n weight: tools.weight weight__empty: tools.weight__empty weight__gt: tools.weight__gt weight__gte: tools.weight__gte weight__lt: tools.weight__lt weight__lte: tools.weight__lte weight__n: tools.weight__n outputParameters: - type: object mapping: $. - name: post-list-saved-filter-objects description: Post a list of saved filter objects. hints: readOnly: true destructive: false idempotent: false call: netbox-extras.extrassavedfilterscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-saved-filter-objects description: Put a list of saved filter objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrassavedfiltersbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-saved-filter-objects description: Patch a list of saved filter objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrassavedfiltersbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-saved-filter-objects description: Delete a list of saved filter objects. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrassavedfiltersbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-saved-filter-object description: Get a saved filter object. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrassavedfiltersretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-saved-filter-object description: Put a saved filter object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrassavedfiltersupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-saved-filter-object description: Patch a saved filter object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrassavedfilterspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-saved-filter-object description: Delete a saved filter object. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrassavedfiltersdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-script-objects description: Get a list of script objects. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrasscriptslist with: id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n is_executable: tools.is_executable limit: tools.limit module_id: tools.module_id module_id__n: tools.module_id__n name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex offset: tools.offset ordering: tools.ordering q: tools.q outputParameters: - type: object mapping: $. - name: post-list-script-objects description: Post a list of script objects. hints: readOnly: true destructive: false idempotent: false call: netbox-extras.extrasscriptscreate outputParameters: - type: object mapping: $. - name: post-list-script-module-objects description: Post a list of script module objects. hints: readOnly: true destructive: false idempotent: false call: netbox-extras.extrasscriptsuploadcreate with: body: tools.body outputParameters: - type: object mapping: $. - name: get-script-object description: Get a script object. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrasscriptsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-script-object description: Put a script object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasscriptsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-script-object description: Patch a script object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrasscriptspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-script-object description: Delete a script object. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrasscriptsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-subscription-objects description: Get a list of subscription objects. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrassubscriptionslist with: limit: tools.limit offset: tools.offset ordering: tools.ordering outputParameters: - type: object mapping: $. - name: post-list-subscription-objects description: Post a list of subscription objects. hints: readOnly: true destructive: false idempotent: false call: netbox-extras.extrassubscriptionscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-subscription-objects description: Put a list of subscription objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrassubscriptionsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-subscription-objects description: Patch a list of subscription objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrassubscriptionsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-subscription-objects description: Delete a list of subscription objects. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrassubscriptionsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-subscription-object description: Get a subscription object. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrassubscriptionsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-subscription-object description: Put a subscription object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrassubscriptionsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-subscription-object description: Patch a subscription object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrassubscriptionspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-subscription-object description: Delete a subscription object. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrassubscriptionsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-table-config-objects description: Get a list of table config objects. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrastableconfigslist with: created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex enabled: tools.enabled id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit modified_by_request: tools.modified_by_request name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex object_type: tools.object_type object_type__n: tools.object_type__n object_type_id: tools.object_type_id object_type_id__n: tools.object_type_id__n offset: tools.offset ordering: tools.ordering q: tools.q shared: tools.shared table: tools.table table__empty: tools.table__empty table__ic: tools.table__ic table__ie: tools.table__ie table__iew: tools.table__iew table__iregex: tools.table__iregex table__isw: tools.table__isw table__n: tools.table__n table__nic: tools.table__nic table__nie: tools.table__nie table__niew: tools.table__niew table__nisw: tools.table__nisw table__regex: tools.table__regex updated_by_request: tools.updated_by_request usable: tools.usable user: tools.user user__n: tools.user__n user_id: tools.user_id user_id__n: tools.user_id__n weight: tools.weight weight__empty: tools.weight__empty weight__gt: tools.weight__gt weight__gte: tools.weight__gte weight__lt: tools.weight__lt weight__lte: tools.weight__lte weight__n: tools.weight__n outputParameters: - type: object mapping: $. - name: post-list-table-config-objects description: Post a list of table config objects. hints: readOnly: true destructive: false idempotent: false call: netbox-extras.extrastableconfigscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-table-config-objects description: Put a list of table config objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrastableconfigsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-table-config-objects description: Patch a list of table config objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrastableconfigsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-table-config-objects description: Delete a list of table config objects. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrastableconfigsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-table-config-object description: Get a table config object. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrastableconfigsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-table-config-object description: Put a table config object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrastableconfigsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-table-config-object description: Patch a table config object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrastableconfigspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-table-config-object description: Delete a table config object. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrastableconfigsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-tagged-item-objects description: Get a list of tagged item objects. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrastaggedobjectslist with: id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n limit: tools.limit object_id: tools.object_id object_id__empty: tools.object_id__empty object_id__gt: tools.object_id__gt object_id__gte: tools.object_id__gte object_id__lt: tools.object_id__lt object_id__lte: tools.object_id__lte object_id__n: tools.object_id__n object_type: tools.object_type object_type__n: tools.object_type__n object_type_id: tools.object_type_id object_type_id__n: tools.object_type_id__n offset: tools.offset ordering: tools.ordering q: tools.q tag: tools.tag tag__n: tools.tag__n tag_id: tools.tag_id tag_id__n: tools.tag_id__n outputParameters: - type: object mapping: $. - name: get-tagged-item-object description: Get a tagged item object. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrastaggedobjectsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-tag-objects description: Get a list of tag objects. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrastagslist with: color: tools.color color__empty: tools.color__empty color__ic: tools.color__ic color__ie: tools.color__ie color__iew: tools.color__iew color__iregex: tools.color__iregex color__isw: tools.color__isw color__n: tools.color__n color__nic: tools.color__nic color__nie: tools.color__nie color__niew: tools.color__niew color__nisw: tools.color__nisw color__regex: tools.color__regex content_type: tools.content_type content_type_id: tools.content_type_id created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex for_object_type_id: tools.for_object_type_id id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit modified_by_request: tools.modified_by_request name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex object_types: tools.object_types object_types__n: tools.object_types__n offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n q: tools.q slug: tools.slug slug__empty: tools.slug__empty slug__ic: tools.slug__ic slug__ie: tools.slug__ie slug__iew: tools.slug__iew slug__iregex: tools.slug__iregex slug__isw: tools.slug__isw slug__n: tools.slug__n slug__nic: tools.slug__nic slug__nie: tools.slug__nie slug__niew: tools.slug__niew slug__nisw: tools.slug__nisw slug__regex: tools.slug__regex updated_by_request: tools.updated_by_request weight: tools.weight weight__empty: tools.weight__empty weight__gt: tools.weight__gt weight__gte: tools.weight__gte weight__lt: tools.weight__lt weight__lte: tools.weight__lte weight__n: tools.weight__n outputParameters: - type: object mapping: $. - name: post-list-tag-objects description: Post a list of tag objects. hints: readOnly: true destructive: false idempotent: false call: netbox-extras.extrastagscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-tag-objects description: Put a list of tag objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrastagsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-tag-objects description: Patch a list of tag objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrastagsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-tag-objects description: Delete a list of tag objects. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrastagsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-tag-object description: Get a tag object. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extrastagsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-tag-object description: Put a tag object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrastagsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-tag-object description: Patch a tag object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extrastagspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-tag-object description: Delete a tag object. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extrastagsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-webhook-objects description: Get a list of webhook objects. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extraswebhookslist with: ca_file_path: tools.ca_file_path ca_file_path__empty: tools.ca_file_path__empty ca_file_path__ic: tools.ca_file_path__ic ca_file_path__ie: tools.ca_file_path__ie ca_file_path__iew: tools.ca_file_path__iew ca_file_path__iregex: tools.ca_file_path__iregex ca_file_path__isw: tools.ca_file_path__isw ca_file_path__n: tools.ca_file_path__n ca_file_path__nic: tools.ca_file_path__nic ca_file_path__nie: tools.ca_file_path__nie ca_file_path__niew: tools.ca_file_path__niew ca_file_path__nisw: tools.ca_file_path__nisw ca_file_path__regex: tools.ca_file_path__regex created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex http_content_type: tools.http_content_type http_content_type__empty: tools.http_content_type__empty http_content_type__ic: tools.http_content_type__ic http_content_type__ie: tools.http_content_type__ie http_content_type__iew: tools.http_content_type__iew http_content_type__iregex: tools.http_content_type__iregex http_content_type__isw: tools.http_content_type__isw http_content_type__n: tools.http_content_type__n http_content_type__nic: tools.http_content_type__nic http_content_type__nie: tools.http_content_type__nie http_content_type__niew: tools.http_content_type__niew http_content_type__nisw: tools.http_content_type__nisw http_content_type__regex: tools.http_content_type__regex http_method: tools.http_method http_method__empty: tools.http_method__empty http_method__ic: tools.http_method__ic http_method__ie: tools.http_method__ie http_method__iew: tools.http_method__iew http_method__iregex: tools.http_method__iregex http_method__isw: tools.http_method__isw http_method__n: tools.http_method__n http_method__nic: tools.http_method__nic http_method__nie: tools.http_method__nie http_method__niew: tools.http_method__niew http_method__nisw: tools.http_method__nisw http_method__regex: tools.http_method__regex id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit modified_by_request: tools.modified_by_request name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n payload_url: tools.payload_url q: tools.q secret: tools.secret secret__empty: tools.secret__empty secret__ic: tools.secret__ic secret__ie: tools.secret__ie secret__iew: tools.secret__iew secret__iregex: tools.secret__iregex secret__isw: tools.secret__isw secret__n: tools.secret__n secret__nic: tools.secret__nic secret__nie: tools.secret__nie secret__niew: tools.secret__niew secret__nisw: tools.secret__nisw secret__regex: tools.secret__regex ssl_verification: tools.ssl_verification tag: tools.tag tag__n: tools.tag__n tag_id: tools.tag_id tag_id__n: tools.tag_id__n updated_by_request: tools.updated_by_request outputParameters: - type: object mapping: $. - name: post-list-webhook-objects description: Post a list of webhook objects. hints: readOnly: true destructive: false idempotent: false call: netbox-extras.extraswebhookscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-webhook-objects description: Put a list of webhook objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extraswebhooksbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-webhook-objects description: Patch a list of webhook objects. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extraswebhooksbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-webhook-objects description: Delete a list of webhook objects. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extraswebhooksbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-webhook-object description: Get a webhook object. hints: readOnly: true destructive: false idempotent: true call: netbox-extras.extraswebhooksretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-webhook-object description: Put a webhook object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extraswebhooksupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-webhook-object description: Patch a webhook object. hints: readOnly: false destructive: false idempotent: true call: netbox-extras.extraswebhookspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-webhook-object description: Delete a webhook object. hints: readOnly: false destructive: true idempotent: true call: netbox-extras.extraswebhooksdestroy with: id: tools.id outputParameters: - type: object mapping: $.