naftiko: 1.0.0-alpha2 info: label: NetBox REST API — ipam description: 'NetBox REST API — ipam. 172 operations. Lead operation: ipam. Self-contained Naftiko capability covering one Netbox business surface.' tags: - Netbox - ipam created: '2026-05-19' modified: '2026-05-19' binds: - namespace: env keys: NETBOX_API_KEY: NETBOX_API_KEY capability: consumes: - type: http namespace: netbox-ipam baseUri: '' description: NetBox REST API — ipam business capability. Self-contained, no shared references. resources: - name: api-ipam-aggregates path: /api/ipam/aggregates/ operations: - name: ipamaggregateslist method: GET description: Get a list of aggregate objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: contact in: query type: array description: Contact - name: contact__n in: query type: array description: Contact - name: contact_group in: query type: array - name: contact_group__n in: query type: array - name: contact_role in: query type: array description: Contact Role - name: contact_role__n in: query type: array description: Contact Role - 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: date_added in: query type: array - name: date_added__empty in: query type: boolean - name: date_added__gt in: query type: array - name: date_added__gte in: query type: array - name: date_added__lt in: query type: array - name: date_added__lte in: query type: array - name: date_added__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: family in: query type: number - 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: 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: prefix in: query type: string description: Prefix - name: q in: query type: string description: Search - name: rir in: query type: array description: RIR (slug) - name: rir__n in: query type: array description: RIR (slug) - name: rir_id in: query type: array description: RIR (ID) - name: rir_id__n in: query type: array description: RIR (ID) - 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: 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 - name: tenant_group__n in: query type: array - name: tenant_group_id in: query type: array - name: tenant_group_id__n in: query type: array - name: tenant_id in: query type: array description: Tenant (ID) - name: tenant_id__n in: query type: array description: Tenant (ID) - name: updated_by_request in: query type: string - name: ipamaggregatescreate method: POST description: Post a list of aggregate objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamaggregatesbulkupdate method: PUT description: Put a list of aggregate objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamaggregatesbulkpartialupdate method: PATCH description: Patch a list of aggregate objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamaggregatesbulkdestroy method: DELETE description: Delete a list of aggregate objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-ipam-aggregates-id path: /api/ipam/aggregates/{id}/ operations: - name: ipamaggregatesretrieve method: GET description: Get a aggregate object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this aggregate. required: true - name: ipamaggregatesupdate method: PUT description: Put a aggregate object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this aggregate. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: ipamaggregatespartialupdate method: PATCH description: Patch a aggregate object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this aggregate. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: ipamaggregatesdestroy method: DELETE description: Delete a aggregate object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this aggregate. required: true - name: api-ipam-asn-ranges path: /api/ipam/asn-ranges/ operations: - name: ipamasnrangeslist method: GET description: Get a list of ASN range 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: end in: query type: array - name: end__empty in: query type: boolean - name: end__gt in: query type: array - name: end__gte in: query type: array - name: end__lt in: query type: array - name: end__lte in: query type: array - name: end__n 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: rir in: query type: array description: RIR (slug) - name: rir__n in: query type: array description: RIR (slug) - name: rir_id in: query type: array description: RIR (ID) - name: rir_id__n in: query type: array description: RIR (ID) - 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: start in: query type: array - name: start__empty in: query type: boolean - name: start__gt in: query type: array - name: start__gte in: query type: array - name: start__lt in: query type: array - name: start__lte in: query type: array - name: start__n in: query type: array - 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: 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 - name: tenant_group__n in: query type: array - name: tenant_group_id in: query type: array - name: tenant_group_id__n in: query type: array - name: tenant_id in: query type: array description: Tenant (ID) - name: tenant_id__n in: query type: array description: Tenant (ID) - name: updated_by_request in: query type: string - name: ipamasnrangescreate method: POST description: Post a list of ASN range objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamasnrangesbulkupdate method: PUT description: Put a list of ASN range objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamasnrangesbulkpartialupdate method: PATCH description: Patch a list of ASN range objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamasnrangesbulkdestroy method: DELETE description: Delete a list of ASN range objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-ipam-asn-ranges-id path: /api/ipam/asn-ranges/{id}/ operations: - name: ipamasnrangesretrieve method: GET description: Get a ASN range object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this ASN range. required: true - name: ipamasnrangesupdate method: PUT description: Put a ASN range object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this ASN range. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: ipamasnrangespartialupdate method: PATCH description: Patch a ASN range object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this ASN range. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: ipamasnrangesdestroy method: DELETE description: Delete a ASN range object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this ASN range. required: true - name: api-ipam-asn-ranges-id-available-asns path: /api/ipam/asn-ranges/{id}/available-asns/ operations: - name: ipamasnrangesavailableasnslist method: GET description: Get a ASN object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer required: true - name: ipamasnrangesavailableasnscreate method: POST description: Post a ASN object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer required: true - name: body in: body type: object description: Request body (JSON). required: true - name: api-ipam-asns path: /api/ipam/asns/ operations: - name: ipamasnslist method: GET description: Get a list of ASN objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: asn in: query type: array - name: asn__empty in: query type: boolean - name: asn__gt in: query type: array - name: asn__gte in: query type: array - name: asn__lt in: query type: array - name: asn__lte in: query type: array - name: asn__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: 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: 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: provider in: query type: array description: Provider (slug) - name: provider__n in: query type: array description: Provider (slug) - name: provider_id in: query type: array description: Provider (ID) - name: provider_id__n in: query type: array description: Provider (ID) - name: q in: query type: string description: Search - name: rir in: query type: array description: RIR (slug) - name: rir__n in: query type: array description: RIR (slug) - name: rir_id in: query type: array description: RIR (ID) - name: rir_id__n in: query type: array description: RIR (ID) - 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 - name: site_group__n in: query type: array - name: site_group_id in: query type: array - name: site_group_id__n in: query type: array - name: site_id in: query type: array description: Site (ID) - name: site_id__n in: query type: array description: Site (ID) - 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: 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 - name: tenant_group__n in: query type: array - name: tenant_group_id in: query type: array - name: tenant_group_id__n in: query type: array - name: tenant_id in: query type: array description: Tenant (ID) - name: tenant_id__n in: query type: array description: Tenant (ID) - name: updated_by_request in: query type: string - name: ipamasnscreate method: POST description: Post a list of ASN objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamasnsbulkupdate method: PUT description: Put a list of ASN objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamasnsbulkpartialupdate method: PATCH description: Patch a list of ASN objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamasnsbulkdestroy method: DELETE description: Delete a list of ASN objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-ipam-asns-id path: /api/ipam/asns/{id}/ operations: - name: ipamasnsretrieve method: GET description: Get a ASN object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this ASN. required: true - name: ipamasnsupdate method: PUT description: Put a ASN object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this ASN. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: ipamasnspartialupdate method: PATCH description: Patch a ASN object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this ASN. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: ipamasnsdestroy method: DELETE description: Delete a ASN object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this ASN. required: true - name: api-ipam-fhrp-group-assignments path: /api/ipam/fhrp-group-assignments/ operations: - name: ipamfhrpgroupassignmentslist method: GET description: Get a list of FHRP group assignment 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: device in: query type: array - name: device_id in: query type: array - name: group_id in: query type: array description: Group (ID) - name: group_id__n in: query type: array description: Group (ID) - 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: interface_id in: query type: array - name: interface_id__empty in: query type: boolean - name: interface_id__gt in: query type: array - name: interface_id__gte in: query type: array - name: interface_id__lt in: query type: array - name: interface_id__lte in: query type: array - name: interface_id__n in: query type: array - name: interface_type in: query type: array - name: interface_type__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: 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: priority in: query type: array - name: priority__empty in: query type: boolean - name: priority__gt in: query type: array - name: priority__gte in: query type: array - name: priority__lt in: query type: array - name: priority__lte in: query type: array - name: priority__n in: query type: array - name: updated_by_request in: query type: string - name: virtual_machine in: query type: array - name: virtual_machine_id in: query type: array - name: ipamfhrpgroupassignmentscreate method: POST description: Post a list of FHRP group assignment objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamfhrpgroupassignmentsbulkupdate method: PUT description: Put a list of FHRP group assignment objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamfhrpgroupassignmentsbulkpartialupdate method: PATCH description: Patch a list of FHRP group assignment objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamfhrpgroupassignmentsbulkdestroy method: DELETE description: Delete a list of FHRP group assignment objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-ipam-fhrp-group-assignments-id path: /api/ipam/fhrp-group-assignments/{id}/ operations: - name: ipamfhrpgroupassignmentsretrieve method: GET description: Get a FHRP group assignment object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this FHRP group assignment. required: true - name: ipamfhrpgroupassignmentsupdate method: PUT description: Put a FHRP group assignment object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this FHRP group assignment. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: ipamfhrpgroupassignmentspartialupdate method: PATCH description: Patch a FHRP group assignment object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this FHRP group assignment. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: ipamfhrpgroupassignmentsdestroy method: DELETE description: Delete a FHRP group assignment object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this FHRP group assignment. required: true - name: api-ipam-fhrp-groups path: /api/ipam/fhrp-groups/ operations: - name: ipamfhrpgroupslist method: GET description: Get a list of FHRP group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: auth_key in: query type: array - name: auth_key__empty in: query type: boolean - name: auth_key__ic in: query type: array - name: auth_key__ie in: query type: array - name: auth_key__iew in: query type: array - name: auth_key__iregex in: query type: array - name: auth_key__isw in: query type: array - name: auth_key__n in: query type: array - name: auth_key__nic in: query type: array - name: auth_key__nie in: query type: array - name: auth_key__niew in: query type: array - name: auth_key__nisw in: query type: array - name: auth_key__regex in: query type: array - name: auth_type in: query type: array - name: auth_type__empty in: query type: boolean - name: auth_type__ic in: query type: array - name: auth_type__ie in: query type: array - name: auth_type__iew in: query type: array - name: auth_type__iregex in: query type: array - name: auth_type__isw in: query type: array - name: auth_type__n in: query type: array - name: auth_type__nic in: query type: array - name: auth_type__nie in: query type: array - name: auth_type__niew in: query type: array - name: auth_type__nisw in: query type: array - name: auth_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: group_id in: query type: array - name: group_id__empty in: query type: boolean - name: group_id__gt in: query type: array - name: group_id__gte in: query type: array - name: group_id__lt in: query type: array - name: group_id__lte in: query type: array - name: group_id__n 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: protocol in: query type: array - name: protocol__empty in: query type: boolean - name: protocol__ic in: query type: array - name: protocol__ie in: query type: array - name: protocol__iew in: query type: array - name: protocol__iregex in: query type: array - name: protocol__isw in: query type: array - name: protocol__n in: query type: array - name: protocol__nic in: query type: array - name: protocol__nie in: query type: array - name: protocol__niew in: query type: array - name: protocol__nisw in: query type: array - name: protocol__regex in: query type: array - name: q in: query type: string description: Search - name: related_ip in: query type: array - 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: ipamfhrpgroupscreate method: POST description: Post a list of FHRP group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamfhrpgroupsbulkupdate method: PUT description: Put a list of FHRP group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamfhrpgroupsbulkpartialupdate method: PATCH description: Patch a list of FHRP group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamfhrpgroupsbulkdestroy method: DELETE description: Delete a list of FHRP 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-ipam-fhrp-groups-id path: /api/ipam/fhrp-groups/{id}/ operations: - name: ipamfhrpgroupsretrieve method: GET description: Get a FHRP group object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this FHRP group. required: true - name: ipamfhrpgroupsupdate method: PUT description: Put a FHRP group object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this FHRP group. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: ipamfhrpgroupspartialupdate method: PATCH description: Patch a FHRP group object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this FHRP group. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: ipamfhrpgroupsdestroy method: DELETE description: Delete a FHRP group object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this FHRP group. required: true - name: api-ipam-ip-addresses path: /api/ipam/ip-addresses/ operations: - name: ipamipaddresseslist method: GET description: Get a list of IP address objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: address in: query type: array - name: assigned in: query type: boolean description: Is assigned - 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_to_interface in: query type: boolean description: Is assigned to an interface - name: contact in: query type: array description: Contact - name: contact__n in: query type: array description: Contact - name: contact_group in: query type: array - name: contact_group__n in: query type: array - name: contact_role in: query type: array description: Contact Role - name: contact_role__n in: query type: array description: Contact Role - 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: device in: query type: array - name: device_id in: query type: array - name: dns_name in: query type: array - name: dns_name__empty in: query type: boolean - name: dns_name__ic in: query type: array - name: dns_name__ie in: query type: array - name: dns_name__iew in: query type: array - name: dns_name__iregex in: query type: array - name: dns_name__isw in: query type: array - name: dns_name__n in: query type: array - name: dns_name__nic in: query type: array - name: dns_name__nie in: query type: array - name: dns_name__niew in: query type: array - name: dns_name__nisw in: query type: array - name: dns_name__regex in: query type: array - name: family in: query type: number - name: fhrpgroup_id in: query type: array description: FHRP group (ID) - name: fhrpgroup_id__n in: query type: array description: FHRP group (ID) - 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: interface in: query type: array description: Interface (name) - name: interface__n in: query type: array description: Interface (name) - name: interface_id in: query type: array description: Interface (ID) - name: interface_id__n in: query type: array description: Interface (ID) - 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: mask_length in: query type: array - name: mask_length__gte in: query type: number - name: mask_length__lte in: query type: number - name: modified_by_request in: query type: string - name: nat_inside_id in: query type: array description: NAT inside IP address (ID) - name: nat_inside_id__n in: query type: array description: NAT inside IP address (ID) - 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: parent in: query type: array - name: present_in_vrf in: query type: string - name: present_in_vrf_id in: query type: string - name: q in: query type: string description: Search - name: role in: query type: array description: The functional role of this IP - name: role__empty in: query type: boolean - name: role__ic in: query type: array description: The functional role of this IP - name: role__ie in: query type: array description: The functional role of this IP - name: role__iew in: query type: array description: The functional role of this IP - name: role__iregex in: query type: array description: The functional role of this IP - name: role__isw in: query type: array description: The functional role of this IP - name: role__n in: query type: array description: The functional role of this IP - name: role__nic in: query type: array description: The functional role of this IP - name: role__nie in: query type: array description: The functional role of this IP - name: role__niew in: query type: array description: The functional role of this IP - name: role__nisw in: query type: array description: The functional role of this IP - name: role__regex in: query type: array description: The functional role of this IP - name: service_id in: query type: array description: Application Service (ID) - name: service_id__n in: query type: array description: Application Service (ID) - name: status in: query type: array description: The operational status of this IP - name: status__empty in: query type: boolean - name: status__ic in: query type: array description: The operational status of this IP - name: status__ie in: query type: array description: The operational status of this IP - name: status__iew in: query type: array description: The operational status of this IP - name: status__iregex in: query type: array description: The operational status of this IP - name: status__isw in: query type: array description: The operational status of this IP - name: status__n in: query type: array description: The operational status of this IP - name: status__nic in: query type: array description: The operational status of this IP - name: status__nie in: query type: array description: The operational status of this IP - name: status__niew in: query type: array description: The operational status of this IP - name: status__nisw in: query type: array description: The operational status of this IP - name: status__regex in: query type: array description: The operational status of this IP - 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: 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 - name: tenant_group__n in: query type: array - name: tenant_group_id in: query type: array - name: tenant_group_id__n in: query type: array - name: tenant_id in: query type: array description: Tenant (ID) - name: tenant_id__n in: query type: array description: Tenant (ID) - name: updated_by_request in: query type: string - name: virtual_machine in: query type: array - name: virtual_machine_id in: query type: array - name: vminterface in: query type: array description: VM interface (name) - name: vminterface__n in: query type: array description: VM interface (name) - name: vminterface_id in: query type: array description: VM interface (ID) - name: vminterface_id__n in: query type: array description: VM interface (ID) - name: vrf in: query type: array description: VRF (RD) - name: vrf__n in: query type: array description: VRF (RD) - name: vrf_id in: query type: array description: VRF - name: vrf_id__n in: query type: array description: VRF - name: ipamipaddressescreate method: POST description: Post a list of IP address objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamipaddressesbulkupdate method: PUT description: Put a list of IP address objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamipaddressesbulkpartialupdate method: PATCH description: Patch a list of IP address objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamipaddressesbulkdestroy method: DELETE description: Delete a list of IP address objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-ipam-ip-addresses-id path: /api/ipam/ip-addresses/{id}/ operations: - name: ipamipaddressesretrieve method: GET description: Get a IP address object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this IP address. required: true - name: ipamipaddressesupdate method: PUT description: Put a IP address object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this IP address. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: ipamipaddressespartialupdate method: PATCH description: Patch a IP address object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this IP address. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: ipamipaddressesdestroy method: DELETE description: Delete a IP address object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this IP address. required: true - name: api-ipam-ip-ranges path: /api/ipam/ip-ranges/ operations: - name: ipamiprangeslist method: GET description: Get a list of IP range objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: contact in: query type: array description: Contact - name: contact__n in: query type: array description: Contact - name: contact_group in: query type: array - name: contact_group__n in: query type: array - name: contact_role in: query type: array description: Contact Role - name: contact_role__n in: query type: array description: Contact Role - name: contains in: query type: string description: Ranges which contain this prefix or IP - 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: end_address in: query type: array - name: family in: query type: number - 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: mark_populated in: query type: boolean - name: mark_utilized in: query type: boolean - 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: 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: parent in: query type: array - name: q in: query type: string description: Search - name: role in: query type: array description: Role (slug) - name: role__n in: query type: array description: Role (slug) - name: role_id in: query type: array description: Role (ID) - name: role_id__n in: query type: array description: Role (ID) - name: size in: query type: array - name: size__empty in: query type: boolean - name: size__gt in: query type: array - name: size__gte in: query type: array - name: size__lt in: query type: array - name: size__lte in: query type: array - name: size__n in: query type: array - name: start_address in: query type: array - name: status in: query type: array description: Operational status of this range - name: status__empty in: query type: boolean - name: status__ic in: query type: array description: Operational status of this range - name: status__ie in: query type: array description: Operational status of this range - name: status__iew in: query type: array description: Operational status of this range - name: status__iregex in: query type: array description: Operational status of this range - name: status__isw in: query type: array description: Operational status of this range - name: status__n in: query type: array description: Operational status of this range - name: status__nic in: query type: array description: Operational status of this range - name: status__nie in: query type: array description: Operational status of this range - name: status__niew in: query type: array description: Operational status of this range - name: status__nisw in: query type: array description: Operational status of this range - name: status__regex in: query type: array description: Operational status of this range - 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: 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 - name: tenant_group__n in: query type: array - name: tenant_group_id in: query type: array - name: tenant_group_id__n in: query type: array - name: tenant_id in: query type: array description: Tenant (ID) - name: tenant_id__n in: query type: array description: Tenant (ID) - name: updated_by_request in: query type: string - name: vrf in: query type: array description: VRF (RD) - name: vrf__n in: query type: array description: VRF (RD) - name: vrf_id in: query type: array description: VRF - name: vrf_id__n in: query type: array description: VRF - name: ipamiprangescreate method: POST description: Post a list of IP range objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamiprangesbulkupdate method: PUT description: Put a list of IP range objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamiprangesbulkpartialupdate method: PATCH description: Patch a list of IP range objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamiprangesbulkdestroy method: DELETE description: Delete a list of IP range objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-ipam-ip-ranges-id path: /api/ipam/ip-ranges/{id}/ operations: - name: ipamiprangesretrieve method: GET description: Get a IP range object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this IP range. required: true - name: ipamiprangesupdate method: PUT description: Put a IP range object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this IP range. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: ipamiprangespartialupdate method: PATCH description: Patch a IP range object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this IP range. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: ipamiprangesdestroy method: DELETE description: Delete a IP range object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this IP range. required: true - name: api-ipam-ip-ranges-id-available-ips path: /api/ipam/ip-ranges/{id}/available-ips/ operations: - name: ipamiprangesavailableipslist method: GET description: Get a IP address object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer required: true - name: ipamiprangesavailableipscreate method: POST description: Post a IP address object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer required: true - name: body in: body type: object description: Request body (JSON). required: true - name: api-ipam-prefixes path: /api/ipam/prefixes/ operations: - name: ipamprefixeslist method: GET description: Get a list of prefix objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: children in: query type: array - name: children__empty in: query type: array - name: children__gt in: query type: array - name: children__gte in: query type: array - name: children__lt in: query type: array - name: children__lte in: query type: array - name: children__n in: query type: array - name: contact in: query type: array description: Contact - name: contact__n in: query type: array description: Contact - name: contact_group in: query type: array - name: contact_group__n in: query type: array - name: contact_role in: query type: array description: Contact Role - name: contact_role__n in: query type: array description: Contact Role - name: contains in: query type: string description: Prefixes which contain this prefix or IP - 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: depth in: query type: array - name: depth__empty in: query type: array - name: depth__gt in: query type: array - name: depth__gte in: query type: array - name: depth__lt in: query type: array - name: depth__lte in: query type: array - name: depth__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: family in: query type: number - 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_pool 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 - name: location__n in: query type: array - name: location_id in: query type: array - name: location_id__n in: query type: array - name: mark_utilized in: query type: boolean - name: mask_length in: query type: array - name: mask_length__gte in: query type: number - name: mask_length__lte in: query type: number - 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: 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: prefix in: query type: array - name: present_in_vrf in: query type: string - name: present_in_vrf_id in: query type: string - name: q in: query type: string description: Search - name: region in: query type: array - name: region__n in: query type: array - name: region_id in: query type: array - name: region_id__n in: query type: array - name: role in: query type: array description: Role (slug) - name: role__n in: query type: array description: Role (slug) - name: role_id in: query type: array description: Role (ID) - name: role_id__n in: query type: array description: Role (ID) - name: scope_id in: query type: array - name: scope_id__empty in: query type: boolean - name: scope_id__gt in: query type: array - name: scope_id__gte in: query type: array - name: scope_id__lt in: query type: array - name: scope_id__lte in: query type: array - name: scope_id__n in: query type: array - name: scope_type in: query type: array - name: scope_type__n in: query type: array - 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 - name: site_group__n in: query type: array - name: site_group_id in: query type: array - name: site_group_id__n in: query type: array - name: site_id in: query type: array description: Site (ID) - name: site_id__n in: query type: array description: Site (ID) - name: status in: query type: array description: Operational status of this prefix - name: status__empty in: query type: boolean - name: status__ic in: query type: array description: Operational status of this prefix - name: status__ie in: query type: array description: Operational status of this prefix - name: status__iew in: query type: array description: Operational status of this prefix - name: status__iregex in: query type: array description: Operational status of this prefix - name: status__isw in: query type: array description: Operational status of this prefix - name: status__n in: query type: array description: Operational status of this prefix - name: status__nic in: query type: array description: Operational status of this prefix - name: status__nie in: query type: array description: Operational status of this prefix - name: status__niew in: query type: array description: Operational status of this prefix - name: status__nisw in: query type: array description: Operational status of this prefix - name: status__regex in: query type: array description: Operational status of this prefix - 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: 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 - name: tenant_group__n in: query type: array - name: tenant_group_id in: query type: array - name: tenant_group_id__n in: query type: array - name: tenant_id in: query type: array description: Tenant (ID) - name: tenant_id__n in: query type: array description: Tenant (ID) - name: updated_by_request in: query type: string - name: vlan_group in: query type: array description: VLAN Group (slug) - name: vlan_group__n in: query type: array description: VLAN Group (slug) - name: vlan_group_id in: query type: array description: VLAN Group (ID) - name: vlan_group_id__n in: query type: array description: VLAN Group (ID) - name: vlan_id in: query type: array description: VLAN (ID) - name: vlan_id__n in: query type: array description: VLAN (ID) - name: vlan_vid in: query type: integer description: VLAN number (1-4094) - name: vlan_vid__empty in: query type: integer description: VLAN number (1-4094) - name: vlan_vid__gt in: query type: integer description: VLAN number (1-4094) - name: vlan_vid__gte in: query type: integer description: VLAN number (1-4094) - name: vlan_vid__lt in: query type: integer description: VLAN number (1-4094) - name: vlan_vid__lte in: query type: integer description: VLAN number (1-4094) - name: vlan_vid__n in: query type: integer description: VLAN number (1-4094) - name: vrf in: query type: array description: VRF (RD) - name: vrf__n in: query type: array description: VRF (RD) - name: vrf_id in: query type: array description: VRF - name: vrf_id__n in: query type: array description: VRF - name: within in: query type: string description: Within prefix - name: within_include in: query type: string description: Within and including prefix - name: ipamprefixescreate method: POST description: Post a list of prefix objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamprefixesbulkupdate method: PUT description: Put a list of prefix objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamprefixesbulkpartialupdate method: PATCH description: Patch a list of prefix objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamprefixesbulkdestroy method: DELETE description: Delete a list of prefix objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-ipam-prefixes-id path: /api/ipam/prefixes/{id}/ operations: - name: ipamprefixesretrieve method: GET description: Get a prefix object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this prefix. required: true - name: ipamprefixesupdate method: PUT description: Put a prefix object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this prefix. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: ipamprefixespartialupdate method: PATCH description: Patch a prefix object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this prefix. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: ipamprefixesdestroy method: DELETE description: Delete a prefix object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this prefix. required: true - name: api-ipam-prefixes-id-available-ips path: /api/ipam/prefixes/{id}/available-ips/ operations: - name: ipamprefixesavailableipslist method: GET description: Get a IP address object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer required: true - name: ipamprefixesavailableipscreate method: POST description: Post a IP address object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer required: true - name: body in: body type: object description: Request body (JSON). required: true - name: api-ipam-prefixes-id-available-prefixes path: /api/ipam/prefixes/{id}/available-prefixes/ operations: - name: ipamprefixesavailableprefixeslist method: GET description: Get a prefix object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer required: true - name: ipamprefixesavailableprefixescreate method: POST description: Post a prefix object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer required: true - name: body in: body type: object description: Request body (JSON). required: true - name: api-ipam-rirs path: /api/ipam/rirs/ operations: - name: ipamrirslist method: GET description: Get a list of RIR 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: is_private 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: 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: 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: 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: ipamrirscreate method: POST description: Post a list of RIR objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamrirsbulkupdate method: PUT description: Put a list of RIR objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamrirsbulkpartialupdate method: PATCH description: Patch a list of RIR objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamrirsbulkdestroy method: DELETE description: Delete a list of RIR objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-ipam-rirs-id path: /api/ipam/rirs/{id}/ operations: - name: ipamrirsretrieve method: GET description: Get a RIR object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this RIR. required: true - name: ipamrirsupdate method: PUT description: Put a RIR object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this RIR. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: ipamrirspartialupdate method: PATCH description: Patch a RIR object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this RIR. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: ipamrirsdestroy method: DELETE description: Delete a RIR object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this RIR. required: true - name: api-ipam-roles path: /api/ipam/roles/ operations: - name: ipamroleslist method: GET description: Get a list of role 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: 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: 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: 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: 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: ipamrolescreate method: POST description: Post a list of role objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamrolesbulkupdate method: PUT description: Put a list of role objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamrolesbulkpartialupdate method: PATCH description: Patch a list of role objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamrolesbulkdestroy method: DELETE description: Delete a list of role objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-ipam-roles-id path: /api/ipam/roles/{id}/ operations: - name: ipamrolesretrieve method: GET description: Get a role object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this role. required: true - name: ipamrolesupdate method: PUT description: Put a role object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this role. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: ipamrolespartialupdate method: PATCH description: Patch a role object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this role. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: ipamrolesdestroy method: DELETE description: Delete a role object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this role. required: true - name: api-ipam-route-targets path: /api/ipam/route-targets/ operations: - name: ipamroutetargetslist method: GET description: Get a list of route target 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: exporting_l2vpn in: query type: array description: Exporting L2VPN (identifier) - name: exporting_l2vpn__n in: query type: array description: Exporting L2VPN (identifier) - name: exporting_l2vpn_id in: query type: array description: Exporting L2VPN - name: exporting_l2vpn_id__n in: query type: array description: Exporting L2VPN - name: exporting_vrf in: query type: array description: Export VRF (RD) - name: exporting_vrf__n in: query type: array description: Export VRF (RD) - name: exporting_vrf_id in: query type: array description: Exporting VRF - name: exporting_vrf_id__n in: query type: array description: Exporting VRF - 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: importing_l2vpn in: query type: array description: Importing L2VPN (identifier) - name: importing_l2vpn__n in: query type: array description: Importing L2VPN (identifier) - name: importing_l2vpn_id in: query type: array description: Importing L2VPN - name: importing_l2vpn_id__n in: query type: array description: Importing L2VPN - name: importing_vrf in: query type: array description: Import VRF (RD) - name: importing_vrf__n in: query type: array description: Import VRF (RD) - name: importing_vrf_id in: query type: array description: Importing VRF - name: importing_vrf_id__n in: query type: array description: Importing VRF - 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: 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 - name: tenant_group__n in: query type: array - name: tenant_group_id in: query type: array - name: tenant_group_id__n in: query type: array - name: tenant_id in: query type: array description: Tenant (ID) - name: tenant_id__n in: query type: array description: Tenant (ID) - name: updated_by_request in: query type: string - name: ipamroutetargetscreate method: POST description: Post a list of route target objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamroutetargetsbulkupdate method: PUT description: Put a list of route target objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamroutetargetsbulkpartialupdate method: PATCH description: Patch a list of route target objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamroutetargetsbulkdestroy method: DELETE description: Delete a list of route target objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-ipam-route-targets-id path: /api/ipam/route-targets/{id}/ operations: - name: ipamroutetargetsretrieve method: GET description: Get a route target object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this route target. required: true - name: ipamroutetargetsupdate method: PUT description: Put a route target object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this route target. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: ipamroutetargetspartialupdate method: PATCH description: Patch a route target object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this route target. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: ipamroutetargetsdestroy method: DELETE description: Delete a route target object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this route target. required: true - name: api-ipam-service-templates path: /api/ipam/service-templates/ operations: - name: ipamservicetemplateslist method: GET description: Get a list of application service template 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: 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: port in: query type: number - name: port__empty in: query type: number - name: port__gt in: query type: number - name: port__gte in: query type: number - name: port__lt in: query type: number - name: port__lte in: query type: number - name: port__n in: query type: number - name: protocol in: query type: string description: '* `tcp` - TCP' - name: protocol__empty in: query type: boolean - name: protocol__ic in: query type: array - name: protocol__ie in: query type: array - name: protocol__iew in: query type: array - name: protocol__iregex in: query type: array - name: protocol__isw in: query type: array - name: protocol__n in: query type: string description: '* `tcp` - TCP' - name: protocol__nic in: query type: array - name: protocol__nie in: query type: array - name: protocol__niew in: query type: array - name: protocol__nisw in: query type: array - name: protocol__regex in: query type: array - 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: ipamservicetemplatescreate method: POST description: Post a list of application service template objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamservicetemplatesbulkupdate method: PUT description: Put a list of application service template objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamservicetemplatesbulkpartialupdate method: PATCH description: Patch a list of application service template objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamservicetemplatesbulkdestroy method: DELETE description: Delete a list of application service 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-ipam-service-templates-id path: /api/ipam/service-templates/{id}/ operations: - name: ipamservicetemplatesretrieve method: GET description: Get a application service template object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this application service template. required: true - name: ipamservicetemplatesupdate method: PUT description: Put a application service template object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this application service template. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: ipamservicetemplatespartialupdate method: PATCH description: Patch a application service template object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this application service template. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: ipamservicetemplatesdestroy method: DELETE description: Delete a application service template object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this application service template. required: true - name: api-ipam-services path: /api/ipam/services/ operations: - name: ipamserviceslist method: GET description: Get a list of application service objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: contact in: query type: array description: Contact - name: contact__n in: query type: array description: Contact - name: contact_group in: query type: array - name: contact_group__n in: query type: array - name: contact_role in: query type: array description: Contact Role - name: contact_role__n in: query type: array description: Contact Role - 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: device in: query type: array - name: device_id in: query type: array - name: fhrpgroup in: query type: array - name: fhrpgroup_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: ip_address in: query type: array description: IP address - name: ip_address__n in: query type: array description: IP address - name: ip_address_id in: query type: array description: IP address (ID) - name: ip_address_id__n in: query type: array description: IP address (ID) - 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: parent_object_id in: query type: array - name: parent_object_id__empty in: query type: boolean - name: parent_object_id__gt in: query type: array - name: parent_object_id__gte in: query type: array - name: parent_object_id__lt in: query type: array - name: parent_object_id__lte in: query type: array - name: parent_object_id__n in: query type: array - name: parent_object_type in: query type: array - name: parent_object_type__n in: query type: array - name: port in: query type: number - name: port__empty in: query type: number - name: port__gt in: query type: number - name: port__gte in: query type: number - name: port__lt in: query type: number - name: port__lte in: query type: number - name: port__n in: query type: number - name: protocol in: query type: string description: '* `tcp` - TCP' - name: protocol__empty in: query type: boolean - name: protocol__ic in: query type: array - name: protocol__ie in: query type: array - name: protocol__iew in: query type: array - name: protocol__iregex in: query type: array - name: protocol__isw in: query type: array - name: protocol__n in: query type: string description: '* `tcp` - TCP' - name: protocol__nic in: query type: array - name: protocol__nie in: query type: array - name: protocol__niew in: query type: array - name: protocol__nisw in: query type: array - name: protocol__regex in: query type: array - 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: virtual_machine in: query type: array - name: virtual_machine_id in: query type: array - name: ipamservicescreate method: POST description: Post a list of application service objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamservicesbulkupdate method: PUT description: Put a list of application service objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamservicesbulkpartialupdate method: PATCH description: Patch a list of application service objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamservicesbulkdestroy method: DELETE description: Delete a list of application service objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-ipam-services-id path: /api/ipam/services/{id}/ operations: - name: ipamservicesretrieve method: GET description: Get a application service object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this application service. required: true - name: ipamservicesupdate method: PUT description: Put a application service object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this application service. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: ipamservicespartialupdate method: PATCH description: Patch a application service object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this application service. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: ipamservicesdestroy method: DELETE description: Delete a application service object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this application service. required: true - name: api-ipam-vlan-groups path: /api/ipam/vlan-groups/ operations: - name: ipamvlangroupslist method: GET description: Get a list of VLAN group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: cluster in: query type: integer - name: cluster_group in: query type: integer - name: contains_vid in: query type: number - 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: location in: query type: integer - 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: rack in: query type: integer - name: region in: query type: integer - name: scope_id in: query type: array - name: scope_id__empty in: query type: boolean - name: scope_id__gt in: query type: array - name: scope_id__gte in: query type: array - name: scope_id__lt in: query type: array - name: scope_id__lte in: query type: array - name: scope_id__n in: query type: array - name: scope_type in: query type: array - name: scope_type__n in: query type: array - name: site in: query type: integer - name: site_group in: query type: integer - 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: 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: 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 - name: tenant_group__n in: query type: array - name: tenant_group_id in: query type: array - name: tenant_group_id__n in: query type: array - name: tenant_id in: query type: array description: Tenant (ID) - name: tenant_id__n in: query type: array description: Tenant (ID) - name: updated_by_request in: query type: string - name: ipamvlangroupscreate method: POST description: Post a list of VLAN group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamvlangroupsbulkupdate method: PUT description: Put a list of VLAN group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamvlangroupsbulkpartialupdate method: PATCH description: Patch a list of VLAN group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamvlangroupsbulkdestroy method: DELETE description: Delete a list of VLAN 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-ipam-vlan-groups-id path: /api/ipam/vlan-groups/{id}/ operations: - name: ipamvlangroupsretrieve method: GET description: Get a VLAN group object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this VLAN group. required: true - name: ipamvlangroupsupdate method: PUT description: Put a VLAN group object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this VLAN group. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: ipamvlangroupspartialupdate method: PATCH description: Patch a VLAN group object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this VLAN group. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: ipamvlangroupsdestroy method: DELETE description: Delete a VLAN group object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this VLAN group. required: true - name: api-ipam-vlan-groups-id-available-vlans path: /api/ipam/vlan-groups/{id}/available-vlans/ operations: - name: ipamvlangroupsavailablevlanslist method: GET description: Get a VLAN object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer required: true - name: ipamvlangroupsavailablevlanscreate method: POST description: Post a VLAN object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer required: true - name: body in: body type: object description: Request body (JSON). required: true - name: api-ipam-vlan-translation-policies path: /api/ipam/vlan-translation-policies/ operations: - name: ipamvlantranslationpolicieslist method: GET description: Get a list of VLAN translation policy 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: 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: ipamvlantranslationpoliciescreate method: POST description: Post a list of VLAN translation policy objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamvlantranslationpoliciesbulkupdate method: PUT description: Put a list of VLAN translation policy objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamvlantranslationpoliciesbulkpartialupdate method: PATCH description: Patch a list of VLAN translation policy objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamvlantranslationpoliciesbulkdestroy method: DELETE description: Delete a list of VLAN translation policy objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-ipam-vlan-translation-policies-id path: /api/ipam/vlan-translation-policies/{id}/ operations: - name: ipamvlantranslationpoliciesretrieve method: GET description: Get a VLAN translation policy object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this VLAN translation policy. required: true - name: ipamvlantranslationpoliciesupdate method: PUT description: Put a VLAN translation policy object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this VLAN translation policy. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: ipamvlantranslationpoliciespartialupdate method: PATCH description: Patch a VLAN translation policy object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this VLAN translation policy. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: ipamvlantranslationpoliciesdestroy method: DELETE description: Delete a VLAN translation policy object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this VLAN translation policy. required: true - name: api-ipam-vlan-translation-rules path: /api/ipam/vlan-translation-rules/ operations: - name: ipamvlantranslationruleslist method: GET description: Get a list of VLAN translation rule 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: 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: local_vid in: query type: array - name: local_vid__empty in: query type: boolean - name: local_vid__gt in: query type: array - name: local_vid__gte in: query type: array - name: local_vid__lt in: query type: array - name: local_vid__lte in: query type: array - name: local_vid__n in: query type: array - 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: policy in: query type: array description: VLAN Translation Policy (name) - name: policy__n in: query type: array description: VLAN Translation Policy (name) - name: policy_id in: query type: array description: VLAN Translation Policy (ID) - name: policy_id__n in: query type: array description: VLAN Translation Policy (ID) - name: q in: query type: string description: Search - name: remote_vid in: query type: array - name: remote_vid__empty in: query type: boolean - name: remote_vid__gt in: query type: array - name: remote_vid__gte in: query type: array - name: remote_vid__lt in: query type: array - name: remote_vid__lte in: query type: array - name: remote_vid__n in: query type: array - 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: ipamvlantranslationrulescreate method: POST description: Post a list of VLAN translation rule objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamvlantranslationrulesbulkupdate method: PUT description: Put a list of VLAN translation rule objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamvlantranslationrulesbulkpartialupdate method: PATCH description: Patch a list of VLAN translation rule objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamvlantranslationrulesbulkdestroy method: DELETE description: Delete a list of VLAN translation 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-ipam-vlan-translation-rules-id path: /api/ipam/vlan-translation-rules/{id}/ operations: - name: ipamvlantranslationrulesretrieve method: GET description: Get a VLAN translation rule object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this VLAN translation rule. required: true - name: ipamvlantranslationrulesupdate method: PUT description: Put a VLAN translation rule object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this VLAN translation rule. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: ipamvlantranslationrulespartialupdate method: PATCH description: Patch a VLAN translation rule object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this VLAN translation rule. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: ipamvlantranslationrulesdestroy method: DELETE description: Delete a VLAN translation rule object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this VLAN translation rule. required: true - name: api-ipam-vlans path: /api/ipam/vlans/ operations: - name: ipamvlanslist method: GET description: Get a list of VLAN objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: available_at_site in: query type: string - name: available_on_device in: query type: string - name: available_on_virtualmachine in: query type: string - 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: group in: query type: array description: Group - name: group__n in: query type: array description: Group - name: group_id in: query type: array description: Group (ID) - name: group_id__n in: query type: array description: Group (ID) - 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: interface_id in: query type: integer - name: l2vpn in: query type: array description: L2VPN - name: l2vpn__n in: query type: array description: L2VPN - name: l2vpn_id in: query type: array description: L2VPN (ID) - name: l2vpn_id__n in: query type: array description: L2VPN (ID) - 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: qinq_role in: query type: array description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) - name: qinq_role__empty in: query type: boolean - name: qinq_role__ic in: query type: array description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) - name: qinq_role__ie in: query type: array description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) - name: qinq_role__iew in: query type: array description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) - name: qinq_role__iregex in: query type: array description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) - name: qinq_role__isw in: query type: array description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) - name: qinq_role__n in: query type: array description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) - name: qinq_role__nic in: query type: array description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) - name: qinq_role__nie in: query type: array description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) - name: qinq_role__niew in: query type: array description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) - name: qinq_role__nisw in: query type: array description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) - name: qinq_role__regex in: query type: array description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) - name: qinq_svlan_id in: query type: array description: Q-in-Q SVLAN (ID) - name: qinq_svlan_id__n in: query type: array description: Q-in-Q SVLAN (ID) - name: qinq_svlan_vid in: query type: array - name: qinq_svlan_vid__empty in: query type: array - name: qinq_svlan_vid__gt in: query type: array - name: qinq_svlan_vid__gte in: query type: array - name: qinq_svlan_vid__lt in: query type: array - name: qinq_svlan_vid__lte in: query type: array - name: qinq_svlan_vid__n in: query type: array - name: region in: query type: array - name: region__n in: query type: array - name: region_id in: query type: array - name: region_id__n in: query type: array - name: role in: query type: array description: Role (slug) - name: role__n in: query type: array description: Role (slug) - name: role_id in: query type: array description: Role (ID) - name: role_id__n in: query type: array description: Role (ID) - 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 - name: site_group__n in: query type: array - name: site_group_id in: query type: array - name: site_group_id__n in: query type: array - name: site_id in: query type: array description: Site (ID) - name: site_id__n in: query type: array description: Site (ID) - name: status in: query type: array description: Operational status of this VLAN - name: status__empty in: query type: boolean - name: status__ic in: query type: array description: Operational status of this VLAN - name: status__ie in: query type: array description: Operational status of this VLAN - name: status__iew in: query type: array description: Operational status of this VLAN - name: status__iregex in: query type: array description: Operational status of this VLAN - name: status__isw in: query type: array description: Operational status of this VLAN - name: status__n in: query type: array description: Operational status of this VLAN - name: status__nic in: query type: array description: Operational status of this VLAN - name: status__nie in: query type: array description: Operational status of this VLAN - name: status__niew in: query type: array description: Operational status of this VLAN - name: status__nisw in: query type: array description: Operational status of this VLAN - name: status__regex in: query type: array description: Operational status of this VLAN - 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: 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 - name: tenant_group__n in: query type: array - name: tenant_group_id in: query type: array - name: tenant_group_id__n in: query type: array - name: tenant_id in: query type: array description: Tenant (ID) - name: tenant_id__n in: query type: array description: Tenant (ID) - name: updated_by_request in: query type: string - name: vid in: query type: array - name: vid__empty in: query type: boolean - name: vid__gt in: query type: array - name: vid__gte in: query type: array - name: vid__lt in: query type: array - name: vid__lte in: query type: array - name: vid__n in: query type: array - name: vminterface_id in: query type: integer - name: ipamvlanscreate method: POST description: Post a list of VLAN objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamvlansbulkupdate method: PUT description: Put a list of VLAN objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamvlansbulkpartialupdate method: PATCH description: Patch a list of VLAN objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamvlansbulkdestroy method: DELETE description: Delete a list of VLAN objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-ipam-vlans-id path: /api/ipam/vlans/{id}/ operations: - name: ipamvlansretrieve method: GET description: Get a VLAN object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this VLAN. required: true - name: ipamvlansupdate method: PUT description: Put a VLAN object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this VLAN. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: ipamvlanspartialupdate method: PATCH description: Patch a VLAN object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this VLAN. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: ipamvlansdestroy method: DELETE description: Delete a VLAN object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this VLAN. required: true - name: api-ipam-vrfs path: /api/ipam/vrfs/ operations: - name: ipamvrfslist method: GET description: Get a list of VRF 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: enforce_unique in: query type: boolean - name: export_target in: query type: array description: Export target (name) - name: export_target__n in: query type: array description: Export target (name) - name: export_target_id in: query type: array description: Export target - name: export_target_id__n in: query type: array description: Export target - 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: import_target in: query type: array description: Import target (name) - name: import_target__n in: query type: array description: Import target (name) - name: import_target_id in: query type: array description: Import target - name: import_target_id__n in: query type: array description: Import target - 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: rd in: query type: array - name: rd__empty in: query type: boolean - name: rd__ic in: query type: array - name: rd__ie in: query type: array - name: rd__iew in: query type: array - name: rd__iregex in: query type: array - name: rd__isw in: query type: array - name: rd__n in: query type: array - name: rd__nic in: query type: array - name: rd__nie in: query type: array - name: rd__niew in: query type: array - name: rd__nisw in: query type: array - name: rd__regex in: query type: array - 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: 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 - name: tenant_group__n in: query type: array - name: tenant_group_id in: query type: array - name: tenant_group_id__n in: query type: array - name: tenant_id in: query type: array description: Tenant (ID) - name: tenant_id__n in: query type: array description: Tenant (ID) - name: updated_by_request in: query type: string - name: ipamvrfscreate method: POST description: Post a list of VRF objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamvrfsbulkupdate method: PUT description: Put a list of VRF objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamvrfsbulkpartialupdate method: PATCH description: Patch a list of VRF objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: ipamvrfsbulkdestroy method: DELETE description: Delete a list of VRF objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-ipam-vrfs-id path: /api/ipam/vrfs/{id}/ operations: - name: ipamvrfsretrieve method: GET description: Get a VRF object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this VRF. required: true - name: ipamvrfsupdate method: PUT description: Put a VRF object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this VRF. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: ipamvrfspartialupdate method: PATCH description: Patch a VRF object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this VRF. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: ipamvrfsdestroy method: DELETE description: Delete a VRF object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this VRF. required: true authentication: type: apikey key: sessionid value: '{{env.NETBOX_API_KEY}}' placement: cookie exposes: - type: rest namespace: netbox-ipam-rest port: 8080 description: REST adapter for NetBox REST API — ipam. One Spectral-compliant resource per consumed operation, prefixed with /v1. resources: - path: /v1/api/ipam/aggregates name: api-ipam-aggregates description: REST surface for api-ipam-aggregates. operations: - method: GET name: ipamaggregateslist description: Get a list of aggregate objects. call: netbox-ipam.ipamaggregateslist with: contact: rest.contact contact__n: rest.contact__n contact_group: rest.contact_group contact_group__n: rest.contact_group__n contact_role: rest.contact_role contact_role__n: rest.contact_role__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 date_added: rest.date_added date_added__empty: rest.date_added__empty date_added__gt: rest.date_added__gt date_added__gte: rest.date_added__gte date_added__lt: rest.date_added__lt date_added__lte: rest.date_added__lte date_added__n: rest.date_added__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 family: rest.family 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 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 prefix: rest.prefix q: rest.q rir: rest.rir rir__n: rest.rir__n rir_id: rest.rir_id rir_id__n: rest.rir_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 outputParameters: - type: object mapping: $. - method: POST name: ipamaggregatescreate description: Post a list of aggregate objects. call: netbox-ipam.ipamaggregatescreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: ipamaggregatesbulkupdate description: Put a list of aggregate objects. call: netbox-ipam.ipamaggregatesbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamaggregatesbulkpartialupdate description: Patch a list of aggregate objects. call: netbox-ipam.ipamaggregatesbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamaggregatesbulkdestroy description: Delete a list of aggregate objects. call: netbox-ipam.ipamaggregatesbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/ipam/aggregates/{id} name: api-ipam-aggregates-id description: REST surface for api-ipam-aggregates-id. operations: - method: GET name: ipamaggregatesretrieve description: Get a aggregate object. call: netbox-ipam.ipamaggregatesretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: ipamaggregatesupdate description: Put a aggregate object. call: netbox-ipam.ipamaggregatesupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamaggregatespartialupdate description: Patch a aggregate object. call: netbox-ipam.ipamaggregatespartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamaggregatesdestroy description: Delete a aggregate object. call: netbox-ipam.ipamaggregatesdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/ipam/asn-ranges name: api-ipam-asn-ranges description: REST surface for api-ipam-asn-ranges. operations: - method: GET name: ipamasnrangeslist description: Get a list of ASN range objects. call: netbox-ipam.ipamasnrangeslist 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 end: rest.end end__empty: rest.end__empty end__gt: rest.end__gt end__gte: rest.end__gte end__lt: rest.end__lt end__lte: rest.end__lte end__n: rest.end__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 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 rir: rest.rir rir__n: rest.rir__n rir_id: rest.rir_id rir_id__n: rest.rir_id__n 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 start: rest.start start__empty: rest.start__empty start__gt: rest.start__gt start__gte: rest.start__gte start__lt: rest.start__lt start__lte: rest.start__lte start__n: rest.start__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 outputParameters: - type: object mapping: $. - method: POST name: ipamasnrangescreate description: Post a list of ASN range objects. call: netbox-ipam.ipamasnrangescreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: ipamasnrangesbulkupdate description: Put a list of ASN range objects. call: netbox-ipam.ipamasnrangesbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamasnrangesbulkpartialupdate description: Patch a list of ASN range objects. call: netbox-ipam.ipamasnrangesbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamasnrangesbulkdestroy description: Delete a list of ASN range objects. call: netbox-ipam.ipamasnrangesbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/ipam/asn-ranges/{id} name: api-ipam-asn-ranges-id description: REST surface for api-ipam-asn-ranges-id. operations: - method: GET name: ipamasnrangesretrieve description: Get a ASN range object. call: netbox-ipam.ipamasnrangesretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: ipamasnrangesupdate description: Put a ASN range object. call: netbox-ipam.ipamasnrangesupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamasnrangespartialupdate description: Patch a ASN range object. call: netbox-ipam.ipamasnrangespartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamasnrangesdestroy description: Delete a ASN range object. call: netbox-ipam.ipamasnrangesdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/ipam/asn-ranges/{id}/available-asns name: api-ipam-asn-ranges-id-available-asns description: REST surface for api-ipam-asn-ranges-id-available-asns. operations: - method: GET name: ipamasnrangesavailableasnslist description: Get a ASN object. call: netbox-ipam.ipamasnrangesavailableasnslist with: id: rest.id outputParameters: - type: object mapping: $. - method: POST name: ipamasnrangesavailableasnscreate description: Post a ASN object. call: netbox-ipam.ipamasnrangesavailableasnscreate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/ipam/asns name: api-ipam-asns description: REST surface for api-ipam-asns. operations: - method: GET name: ipamasnslist description: Get a list of ASN objects. call: netbox-ipam.ipamasnslist with: asn: rest.asn asn__empty: rest.asn__empty asn__gt: rest.asn__gt asn__gte: rest.asn__gte asn__lt: rest.asn__lt asn__lte: rest.asn__lte asn__n: rest.asn__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 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 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 provider: rest.provider provider__n: rest.provider__n provider_id: rest.provider_id provider_id__n: rest.provider_id__n q: rest.q rir: rest.rir rir__n: rest.rir__n rir_id: rest.rir_id rir_id__n: rest.rir_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 outputParameters: - type: object mapping: $. - method: POST name: ipamasnscreate description: Post a list of ASN objects. call: netbox-ipam.ipamasnscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: ipamasnsbulkupdate description: Put a list of ASN objects. call: netbox-ipam.ipamasnsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamasnsbulkpartialupdate description: Patch a list of ASN objects. call: netbox-ipam.ipamasnsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamasnsbulkdestroy description: Delete a list of ASN objects. call: netbox-ipam.ipamasnsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/ipam/asns/{id} name: api-ipam-asns-id description: REST surface for api-ipam-asns-id. operations: - method: GET name: ipamasnsretrieve description: Get a ASN object. call: netbox-ipam.ipamasnsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: ipamasnsupdate description: Put a ASN object. call: netbox-ipam.ipamasnsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamasnspartialupdate description: Patch a ASN object. call: netbox-ipam.ipamasnspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamasnsdestroy description: Delete a ASN object. call: netbox-ipam.ipamasnsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/ipam/fhrp-group-assignments name: api-ipam-fhrp-group-assignments description: REST surface for api-ipam-fhrp-group-assignments. operations: - method: GET name: ipamfhrpgroupassignmentslist description: Get a list of FHRP group assignment objects. call: netbox-ipam.ipamfhrpgroupassignmentslist 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 device: rest.device device_id: rest.device_id group_id: rest.group_id group_id__n: rest.group_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 interface_id: rest.interface_id interface_id__empty: rest.interface_id__empty interface_id__gt: rest.interface_id__gt interface_id__gte: rest.interface_id__gte interface_id__lt: rest.interface_id__lt interface_id__lte: rest.interface_id__lte interface_id__n: rest.interface_id__n interface_type: rest.interface_type interface_type__n: rest.interface_type__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 offset: rest.offset ordering: rest.ordering priority: rest.priority priority__empty: rest.priority__empty priority__gt: rest.priority__gt priority__gte: rest.priority__gte priority__lt: rest.priority__lt priority__lte: rest.priority__lte priority__n: rest.priority__n updated_by_request: rest.updated_by_request virtual_machine: rest.virtual_machine virtual_machine_id: rest.virtual_machine_id outputParameters: - type: object mapping: $. - method: POST name: ipamfhrpgroupassignmentscreate description: Post a list of FHRP group assignment objects. call: netbox-ipam.ipamfhrpgroupassignmentscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: ipamfhrpgroupassignmentsbulkupdate description: Put a list of FHRP group assignment objects. call: netbox-ipam.ipamfhrpgroupassignmentsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamfhrpgroupassignmentsbulkpartialupdate description: Patch a list of FHRP group assignment objects. call: netbox-ipam.ipamfhrpgroupassignmentsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamfhrpgroupassignmentsbulkdestroy description: Delete a list of FHRP group assignment objects. call: netbox-ipam.ipamfhrpgroupassignmentsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/ipam/fhrp-group-assignments/{id} name: api-ipam-fhrp-group-assignments-id description: REST surface for api-ipam-fhrp-group-assignments-id. operations: - method: GET name: ipamfhrpgroupassignmentsretrieve description: Get a FHRP group assignment object. call: netbox-ipam.ipamfhrpgroupassignmentsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: ipamfhrpgroupassignmentsupdate description: Put a FHRP group assignment object. call: netbox-ipam.ipamfhrpgroupassignmentsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamfhrpgroupassignmentspartialupdate description: Patch a FHRP group assignment object. call: netbox-ipam.ipamfhrpgroupassignmentspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamfhrpgroupassignmentsdestroy description: Delete a FHRP group assignment object. call: netbox-ipam.ipamfhrpgroupassignmentsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/ipam/fhrp-groups name: api-ipam-fhrp-groups description: REST surface for api-ipam-fhrp-groups. operations: - method: GET name: ipamfhrpgroupslist description: Get a list of FHRP group objects. call: netbox-ipam.ipamfhrpgroupslist with: auth_key: rest.auth_key auth_key__empty: rest.auth_key__empty auth_key__ic: rest.auth_key__ic auth_key__ie: rest.auth_key__ie auth_key__iew: rest.auth_key__iew auth_key__iregex: rest.auth_key__iregex auth_key__isw: rest.auth_key__isw auth_key__n: rest.auth_key__n auth_key__nic: rest.auth_key__nic auth_key__nie: rest.auth_key__nie auth_key__niew: rest.auth_key__niew auth_key__nisw: rest.auth_key__nisw auth_key__regex: rest.auth_key__regex auth_type: rest.auth_type auth_type__empty: rest.auth_type__empty auth_type__ic: rest.auth_type__ic auth_type__ie: rest.auth_type__ie auth_type__iew: rest.auth_type__iew auth_type__iregex: rest.auth_type__iregex auth_type__isw: rest.auth_type__isw auth_type__n: rest.auth_type__n auth_type__nic: rest.auth_type__nic auth_type__nie: rest.auth_type__nie auth_type__niew: rest.auth_type__niew auth_type__nisw: rest.auth_type__nisw auth_type__regex: rest.auth_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 group_id: rest.group_id group_id__empty: rest.group_id__empty group_id__gt: rest.group_id__gt group_id__gte: rest.group_id__gte group_id__lt: rest.group_id__lt group_id__lte: rest.group_id__lte group_id__n: rest.group_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 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 protocol: rest.protocol protocol__empty: rest.protocol__empty protocol__ic: rest.protocol__ic protocol__ie: rest.protocol__ie protocol__iew: rest.protocol__iew protocol__iregex: rest.protocol__iregex protocol__isw: rest.protocol__isw protocol__n: rest.protocol__n protocol__nic: rest.protocol__nic protocol__nie: rest.protocol__nie protocol__niew: rest.protocol__niew protocol__nisw: rest.protocol__nisw protocol__regex: rest.protocol__regex q: rest.q related_ip: rest.related_ip 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: ipamfhrpgroupscreate description: Post a list of FHRP group objects. call: netbox-ipam.ipamfhrpgroupscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: ipamfhrpgroupsbulkupdate description: Put a list of FHRP group objects. call: netbox-ipam.ipamfhrpgroupsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamfhrpgroupsbulkpartialupdate description: Patch a list of FHRP group objects. call: netbox-ipam.ipamfhrpgroupsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamfhrpgroupsbulkdestroy description: Delete a list of FHRP group objects. call: netbox-ipam.ipamfhrpgroupsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/ipam/fhrp-groups/{id} name: api-ipam-fhrp-groups-id description: REST surface for api-ipam-fhrp-groups-id. operations: - method: GET name: ipamfhrpgroupsretrieve description: Get a FHRP group object. call: netbox-ipam.ipamfhrpgroupsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: ipamfhrpgroupsupdate description: Put a FHRP group object. call: netbox-ipam.ipamfhrpgroupsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamfhrpgroupspartialupdate description: Patch a FHRP group object. call: netbox-ipam.ipamfhrpgroupspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamfhrpgroupsdestroy description: Delete a FHRP group object. call: netbox-ipam.ipamfhrpgroupsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/ipam/ip-addresses name: api-ipam-ip-addresses description: REST surface for api-ipam-ip-addresses. operations: - method: GET name: ipamipaddresseslist description: Get a list of IP address objects. call: netbox-ipam.ipamipaddresseslist with: address: rest.address assigned: rest.assigned 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_to_interface: rest.assigned_to_interface contact: rest.contact contact__n: rest.contact__n contact_group: rest.contact_group contact_group__n: rest.contact_group__n contact_role: rest.contact_role contact_role__n: rest.contact_role__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 device: rest.device device_id: rest.device_id dns_name: rest.dns_name dns_name__empty: rest.dns_name__empty dns_name__ic: rest.dns_name__ic dns_name__ie: rest.dns_name__ie dns_name__iew: rest.dns_name__iew dns_name__iregex: rest.dns_name__iregex dns_name__isw: rest.dns_name__isw dns_name__n: rest.dns_name__n dns_name__nic: rest.dns_name__nic dns_name__nie: rest.dns_name__nie dns_name__niew: rest.dns_name__niew dns_name__nisw: rest.dns_name__nisw dns_name__regex: rest.dns_name__regex family: rest.family fhrpgroup_id: rest.fhrpgroup_id fhrpgroup_id__n: rest.fhrpgroup_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 interface: rest.interface interface__n: rest.interface__n interface_id: rest.interface_id interface_id__n: rest.interface_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 mask_length: rest.mask_length mask_length__gte: rest.mask_length__gte mask_length__lte: rest.mask_length__lte modified_by_request: rest.modified_by_request nat_inside_id: rest.nat_inside_id nat_inside_id__n: rest.nat_inside_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 parent: rest.parent present_in_vrf: rest.present_in_vrf present_in_vrf_id: rest.present_in_vrf_id q: rest.q role: rest.role role__empty: rest.role__empty role__ic: rest.role__ic role__ie: rest.role__ie role__iew: rest.role__iew role__iregex: rest.role__iregex role__isw: rest.role__isw role__n: rest.role__n role__nic: rest.role__nic role__nie: rest.role__nie role__niew: rest.role__niew role__nisw: rest.role__nisw role__regex: rest.role__regex service_id: rest.service_id service_id__n: rest.service_id__n status: rest.status status__empty: rest.status__empty status__ic: rest.status__ic status__ie: rest.status__ie status__iew: rest.status__iew status__iregex: rest.status__iregex status__isw: rest.status__isw status__n: rest.status__n status__nic: rest.status__nic status__nie: rest.status__nie status__niew: rest.status__niew status__nisw: rest.status__nisw status__regex: rest.status__regex 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 virtual_machine: rest.virtual_machine virtual_machine_id: rest.virtual_machine_id vminterface: rest.vminterface vminterface__n: rest.vminterface__n vminterface_id: rest.vminterface_id vminterface_id__n: rest.vminterface_id__n vrf: rest.vrf vrf__n: rest.vrf__n vrf_id: rest.vrf_id vrf_id__n: rest.vrf_id__n outputParameters: - type: object mapping: $. - method: POST name: ipamipaddressescreate description: Post a list of IP address objects. call: netbox-ipam.ipamipaddressescreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: ipamipaddressesbulkupdate description: Put a list of IP address objects. call: netbox-ipam.ipamipaddressesbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamipaddressesbulkpartialupdate description: Patch a list of IP address objects. call: netbox-ipam.ipamipaddressesbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamipaddressesbulkdestroy description: Delete a list of IP address objects. call: netbox-ipam.ipamipaddressesbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/ipam/ip-addresses/{id} name: api-ipam-ip-addresses-id description: REST surface for api-ipam-ip-addresses-id. operations: - method: GET name: ipamipaddressesretrieve description: Get a IP address object. call: netbox-ipam.ipamipaddressesretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: ipamipaddressesupdate description: Put a IP address object. call: netbox-ipam.ipamipaddressesupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamipaddressespartialupdate description: Patch a IP address object. call: netbox-ipam.ipamipaddressespartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamipaddressesdestroy description: Delete a IP address object. call: netbox-ipam.ipamipaddressesdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/ipam/ip-ranges name: api-ipam-ip-ranges description: REST surface for api-ipam-ip-ranges. operations: - method: GET name: ipamiprangeslist description: Get a list of IP range objects. call: netbox-ipam.ipamiprangeslist with: contact: rest.contact contact__n: rest.contact__n contact_group: rest.contact_group contact_group__n: rest.contact_group__n contact_role: rest.contact_role contact_role__n: rest.contact_role__n contains: rest.contains 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 end_address: rest.end_address family: rest.family 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 mark_populated: rest.mark_populated mark_utilized: rest.mark_utilized modified_by_request: rest.modified_by_request 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 parent: rest.parent q: rest.q role: rest.role role__n: rest.role__n role_id: rest.role_id role_id__n: rest.role_id__n size: rest.size size__empty: rest.size__empty size__gt: rest.size__gt size__gte: rest.size__gte size__lt: rest.size__lt size__lte: rest.size__lte size__n: rest.size__n start_address: rest.start_address status: rest.status status__empty: rest.status__empty status__ic: rest.status__ic status__ie: rest.status__ie status__iew: rest.status__iew status__iregex: rest.status__iregex status__isw: rest.status__isw status__n: rest.status__n status__nic: rest.status__nic status__nie: rest.status__nie status__niew: rest.status__niew status__nisw: rest.status__nisw status__regex: rest.status__regex 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 vrf: rest.vrf vrf__n: rest.vrf__n vrf_id: rest.vrf_id vrf_id__n: rest.vrf_id__n outputParameters: - type: object mapping: $. - method: POST name: ipamiprangescreate description: Post a list of IP range objects. call: netbox-ipam.ipamiprangescreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: ipamiprangesbulkupdate description: Put a list of IP range objects. call: netbox-ipam.ipamiprangesbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamiprangesbulkpartialupdate description: Patch a list of IP range objects. call: netbox-ipam.ipamiprangesbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamiprangesbulkdestroy description: Delete a list of IP range objects. call: netbox-ipam.ipamiprangesbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/ipam/ip-ranges/{id} name: api-ipam-ip-ranges-id description: REST surface for api-ipam-ip-ranges-id. operations: - method: GET name: ipamiprangesretrieve description: Get a IP range object. call: netbox-ipam.ipamiprangesretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: ipamiprangesupdate description: Put a IP range object. call: netbox-ipam.ipamiprangesupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamiprangespartialupdate description: Patch a IP range object. call: netbox-ipam.ipamiprangespartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamiprangesdestroy description: Delete a IP range object. call: netbox-ipam.ipamiprangesdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/ipam/ip-ranges/{id}/available-ips name: api-ipam-ip-ranges-id-available-ips description: REST surface for api-ipam-ip-ranges-id-available-ips. operations: - method: GET name: ipamiprangesavailableipslist description: Get a IP address object. call: netbox-ipam.ipamiprangesavailableipslist with: id: rest.id outputParameters: - type: object mapping: $. - method: POST name: ipamiprangesavailableipscreate description: Post a IP address object. call: netbox-ipam.ipamiprangesavailableipscreate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/ipam/prefixes name: api-ipam-prefixes description: REST surface for api-ipam-prefixes. operations: - method: GET name: ipamprefixeslist description: Get a list of prefix objects. call: netbox-ipam.ipamprefixeslist with: children: rest.children children__empty: rest.children__empty children__gt: rest.children__gt children__gte: rest.children__gte children__lt: rest.children__lt children__lte: rest.children__lte children__n: rest.children__n contact: rest.contact contact__n: rest.contact__n contact_group: rest.contact_group contact_group__n: rest.contact_group__n contact_role: rest.contact_role contact_role__n: rest.contact_role__n contains: rest.contains 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 depth: rest.depth depth__empty: rest.depth__empty depth__gt: rest.depth__gt depth__gte: rest.depth__gte depth__lt: rest.depth__lt depth__lte: rest.depth__lte depth__n: rest.depth__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 family: rest.family 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_pool: rest.is_pool 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 mark_utilized: rest.mark_utilized mask_length: rest.mask_length mask_length__gte: rest.mask_length__gte mask_length__lte: rest.mask_length__lte modified_by_request: rest.modified_by_request 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 prefix: rest.prefix present_in_vrf: rest.present_in_vrf present_in_vrf_id: rest.present_in_vrf_id q: rest.q region: rest.region region__n: rest.region__n region_id: rest.region_id region_id__n: rest.region_id__n role: rest.role role__n: rest.role__n role_id: rest.role_id role_id__n: rest.role_id__n scope_id: rest.scope_id scope_id__empty: rest.scope_id__empty scope_id__gt: rest.scope_id__gt scope_id__gte: rest.scope_id__gte scope_id__lt: rest.scope_id__lt scope_id__lte: rest.scope_id__lte scope_id__n: rest.scope_id__n scope_type: rest.scope_type scope_type__n: rest.scope_type__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 status: rest.status status__empty: rest.status__empty status__ic: rest.status__ic status__ie: rest.status__ie status__iew: rest.status__iew status__iregex: rest.status__iregex status__isw: rest.status__isw status__n: rest.status__n status__nic: rest.status__nic status__nie: rest.status__nie status__niew: rest.status__niew status__nisw: rest.status__nisw status__regex: rest.status__regex 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 vlan_group: rest.vlan_group vlan_group__n: rest.vlan_group__n vlan_group_id: rest.vlan_group_id vlan_group_id__n: rest.vlan_group_id__n vlan_id: rest.vlan_id vlan_id__n: rest.vlan_id__n vlan_vid: rest.vlan_vid vlan_vid__empty: rest.vlan_vid__empty vlan_vid__gt: rest.vlan_vid__gt vlan_vid__gte: rest.vlan_vid__gte vlan_vid__lt: rest.vlan_vid__lt vlan_vid__lte: rest.vlan_vid__lte vlan_vid__n: rest.vlan_vid__n vrf: rest.vrf vrf__n: rest.vrf__n vrf_id: rest.vrf_id vrf_id__n: rest.vrf_id__n within: rest.within within_include: rest.within_include outputParameters: - type: object mapping: $. - method: POST name: ipamprefixescreate description: Post a list of prefix objects. call: netbox-ipam.ipamprefixescreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: ipamprefixesbulkupdate description: Put a list of prefix objects. call: netbox-ipam.ipamprefixesbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamprefixesbulkpartialupdate description: Patch a list of prefix objects. call: netbox-ipam.ipamprefixesbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamprefixesbulkdestroy description: Delete a list of prefix objects. call: netbox-ipam.ipamprefixesbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/ipam/prefixes/{id} name: api-ipam-prefixes-id description: REST surface for api-ipam-prefixes-id. operations: - method: GET name: ipamprefixesretrieve description: Get a prefix object. call: netbox-ipam.ipamprefixesretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: ipamprefixesupdate description: Put a prefix object. call: netbox-ipam.ipamprefixesupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamprefixespartialupdate description: Patch a prefix object. call: netbox-ipam.ipamprefixespartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamprefixesdestroy description: Delete a prefix object. call: netbox-ipam.ipamprefixesdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/ipam/prefixes/{id}/available-ips name: api-ipam-prefixes-id-available-ips description: REST surface for api-ipam-prefixes-id-available-ips. operations: - method: GET name: ipamprefixesavailableipslist description: Get a IP address object. call: netbox-ipam.ipamprefixesavailableipslist with: id: rest.id outputParameters: - type: object mapping: $. - method: POST name: ipamprefixesavailableipscreate description: Post a IP address object. call: netbox-ipam.ipamprefixesavailableipscreate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/ipam/prefixes/{id}/available-prefixes name: api-ipam-prefixes-id-available-prefixes description: REST surface for api-ipam-prefixes-id-available-prefixes. operations: - method: GET name: ipamprefixesavailableprefixeslist description: Get a prefix object. call: netbox-ipam.ipamprefixesavailableprefixeslist with: id: rest.id outputParameters: - type: object mapping: $. - method: POST name: ipamprefixesavailableprefixescreate description: Post a prefix object. call: netbox-ipam.ipamprefixesavailableprefixescreate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/ipam/rirs name: api-ipam-rirs description: REST surface for api-ipam-rirs. operations: - method: GET name: ipamrirslist description: Get a list of RIR objects. call: netbox-ipam.ipamrirslist 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 is_private: rest.is_private 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 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 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: ipamrirscreate description: Post a list of RIR objects. call: netbox-ipam.ipamrirscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: ipamrirsbulkupdate description: Put a list of RIR objects. call: netbox-ipam.ipamrirsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamrirsbulkpartialupdate description: Patch a list of RIR objects. call: netbox-ipam.ipamrirsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamrirsbulkdestroy description: Delete a list of RIR objects. call: netbox-ipam.ipamrirsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/ipam/rirs/{id} name: api-ipam-rirs-id description: REST surface for api-ipam-rirs-id. operations: - method: GET name: ipamrirsretrieve description: Get a RIR object. call: netbox-ipam.ipamrirsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: ipamrirsupdate description: Put a RIR object. call: netbox-ipam.ipamrirsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamrirspartialupdate description: Patch a RIR object. call: netbox-ipam.ipamrirspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamrirsdestroy description: Delete a RIR object. call: netbox-ipam.ipamrirsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/ipam/roles name: api-ipam-roles description: REST surface for api-ipam-roles. operations: - method: GET name: ipamroleslist description: Get a list of role objects. call: netbox-ipam.ipamroleslist 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 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 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 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 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: ipamrolescreate description: Post a list of role objects. call: netbox-ipam.ipamrolescreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: ipamrolesbulkupdate description: Put a list of role objects. call: netbox-ipam.ipamrolesbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamrolesbulkpartialupdate description: Patch a list of role objects. call: netbox-ipam.ipamrolesbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamrolesbulkdestroy description: Delete a list of role objects. call: netbox-ipam.ipamrolesbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/ipam/roles/{id} name: api-ipam-roles-id description: REST surface for api-ipam-roles-id. operations: - method: GET name: ipamrolesretrieve description: Get a role object. call: netbox-ipam.ipamrolesretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: ipamrolesupdate description: Put a role object. call: netbox-ipam.ipamrolesupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamrolespartialupdate description: Patch a role object. call: netbox-ipam.ipamrolespartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamrolesdestroy description: Delete a role object. call: netbox-ipam.ipamrolesdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/ipam/route-targets name: api-ipam-route-targets description: REST surface for api-ipam-route-targets. operations: - method: GET name: ipamroutetargetslist description: Get a list of route target objects. call: netbox-ipam.ipamroutetargetslist 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 exporting_l2vpn: rest.exporting_l2vpn exporting_l2vpn__n: rest.exporting_l2vpn__n exporting_l2vpn_id: rest.exporting_l2vpn_id exporting_l2vpn_id__n: rest.exporting_l2vpn_id__n exporting_vrf: rest.exporting_vrf exporting_vrf__n: rest.exporting_vrf__n exporting_vrf_id: rest.exporting_vrf_id exporting_vrf_id__n: rest.exporting_vrf_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 importing_l2vpn: rest.importing_l2vpn importing_l2vpn__n: rest.importing_l2vpn__n importing_l2vpn_id: rest.importing_l2vpn_id importing_l2vpn_id__n: rest.importing_l2vpn_id__n importing_vrf: rest.importing_vrf importing_vrf__n: rest.importing_vrf__n importing_vrf_id: rest.importing_vrf_id importing_vrf_id__n: rest.importing_vrf_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 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 outputParameters: - type: object mapping: $. - method: POST name: ipamroutetargetscreate description: Post a list of route target objects. call: netbox-ipam.ipamroutetargetscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: ipamroutetargetsbulkupdate description: Put a list of route target objects. call: netbox-ipam.ipamroutetargetsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamroutetargetsbulkpartialupdate description: Patch a list of route target objects. call: netbox-ipam.ipamroutetargetsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamroutetargetsbulkdestroy description: Delete a list of route target objects. call: netbox-ipam.ipamroutetargetsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/ipam/route-targets/{id} name: api-ipam-route-targets-id description: REST surface for api-ipam-route-targets-id. operations: - method: GET name: ipamroutetargetsretrieve description: Get a route target object. call: netbox-ipam.ipamroutetargetsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: ipamroutetargetsupdate description: Put a route target object. call: netbox-ipam.ipamroutetargetsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamroutetargetspartialupdate description: Patch a route target object. call: netbox-ipam.ipamroutetargetspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamroutetargetsdestroy description: Delete a route target object. call: netbox-ipam.ipamroutetargetsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/ipam/service-templates name: api-ipam-service-templates description: REST surface for api-ipam-service-templates. operations: - method: GET name: ipamservicetemplateslist description: Get a list of application service template objects. call: netbox-ipam.ipamservicetemplateslist 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 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 port: rest.port port__empty: rest.port__empty port__gt: rest.port__gt port__gte: rest.port__gte port__lt: rest.port__lt port__lte: rest.port__lte port__n: rest.port__n protocol: rest.protocol protocol__empty: rest.protocol__empty protocol__ic: rest.protocol__ic protocol__ie: rest.protocol__ie protocol__iew: rest.protocol__iew protocol__iregex: rest.protocol__iregex protocol__isw: rest.protocol__isw protocol__n: rest.protocol__n protocol__nic: rest.protocol__nic protocol__nie: rest.protocol__nie protocol__niew: rest.protocol__niew protocol__nisw: rest.protocol__nisw protocol__regex: rest.protocol__regex 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: ipamservicetemplatescreate description: Post a list of application service template objects. call: netbox-ipam.ipamservicetemplatescreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: ipamservicetemplatesbulkupdate description: Put a list of application service template objects. call: netbox-ipam.ipamservicetemplatesbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamservicetemplatesbulkpartialupdate description: Patch a list of application service template objects. call: netbox-ipam.ipamservicetemplatesbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamservicetemplatesbulkdestroy description: Delete a list of application service template objects. call: netbox-ipam.ipamservicetemplatesbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/ipam/service-templates/{id} name: api-ipam-service-templates-id description: REST surface for api-ipam-service-templates-id. operations: - method: GET name: ipamservicetemplatesretrieve description: Get a application service template object. call: netbox-ipam.ipamservicetemplatesretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: ipamservicetemplatesupdate description: Put a application service template object. call: netbox-ipam.ipamservicetemplatesupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamservicetemplatespartialupdate description: Patch a application service template object. call: netbox-ipam.ipamservicetemplatespartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamservicetemplatesdestroy description: Delete a application service template object. call: netbox-ipam.ipamservicetemplatesdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/ipam/services name: api-ipam-services description: REST surface for api-ipam-services. operations: - method: GET name: ipamserviceslist description: Get a list of application service objects. call: netbox-ipam.ipamserviceslist with: contact: rest.contact contact__n: rest.contact__n contact_group: rest.contact_group contact_group__n: rest.contact_group__n contact_role: rest.contact_role contact_role__n: rest.contact_role__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 device: rest.device device_id: rest.device_id fhrpgroup: rest.fhrpgroup fhrpgroup_id: rest.fhrpgroup_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 ip_address: rest.ip_address ip_address__n: rest.ip_address__n ip_address_id: rest.ip_address_id ip_address_id__n: rest.ip_address_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 parent_object_id: rest.parent_object_id parent_object_id__empty: rest.parent_object_id__empty parent_object_id__gt: rest.parent_object_id__gt parent_object_id__gte: rest.parent_object_id__gte parent_object_id__lt: rest.parent_object_id__lt parent_object_id__lte: rest.parent_object_id__lte parent_object_id__n: rest.parent_object_id__n parent_object_type: rest.parent_object_type parent_object_type__n: rest.parent_object_type__n port: rest.port port__empty: rest.port__empty port__gt: rest.port__gt port__gte: rest.port__gte port__lt: rest.port__lt port__lte: rest.port__lte port__n: rest.port__n protocol: rest.protocol protocol__empty: rest.protocol__empty protocol__ic: rest.protocol__ic protocol__ie: rest.protocol__ie protocol__iew: rest.protocol__iew protocol__iregex: rest.protocol__iregex protocol__isw: rest.protocol__isw protocol__n: rest.protocol__n protocol__nic: rest.protocol__nic protocol__nie: rest.protocol__nie protocol__niew: rest.protocol__niew protocol__nisw: rest.protocol__nisw protocol__regex: rest.protocol__regex 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 virtual_machine: rest.virtual_machine virtual_machine_id: rest.virtual_machine_id outputParameters: - type: object mapping: $. - method: POST name: ipamservicescreate description: Post a list of application service objects. call: netbox-ipam.ipamservicescreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: ipamservicesbulkupdate description: Put a list of application service objects. call: netbox-ipam.ipamservicesbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamservicesbulkpartialupdate description: Patch a list of application service objects. call: netbox-ipam.ipamservicesbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamservicesbulkdestroy description: Delete a list of application service objects. call: netbox-ipam.ipamservicesbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/ipam/services/{id} name: api-ipam-services-id description: REST surface for api-ipam-services-id. operations: - method: GET name: ipamservicesretrieve description: Get a application service object. call: netbox-ipam.ipamservicesretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: ipamservicesupdate description: Put a application service object. call: netbox-ipam.ipamservicesupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamservicespartialupdate description: Patch a application service object. call: netbox-ipam.ipamservicespartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamservicesdestroy description: Delete a application service object. call: netbox-ipam.ipamservicesdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/ipam/vlan-groups name: api-ipam-vlan-groups description: REST surface for api-ipam-vlan-groups. operations: - method: GET name: ipamvlangroupslist description: Get a list of VLAN group objects. call: netbox-ipam.ipamvlangroupslist with: cluster: rest.cluster cluster_group: rest.cluster_group contains_vid: rest.contains_vid 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 location: rest.location 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 rack: rest.rack region: rest.region scope_id: rest.scope_id scope_id__empty: rest.scope_id__empty scope_id__gt: rest.scope_id__gt scope_id__gte: rest.scope_id__gte scope_id__lt: rest.scope_id__lt scope_id__lte: rest.scope_id__lte scope_id__n: rest.scope_id__n scope_type: rest.scope_type scope_type__n: rest.scope_type__n site: rest.site site_group: rest.site_group 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 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 outputParameters: - type: object mapping: $. - method: POST name: ipamvlangroupscreate description: Post a list of VLAN group objects. call: netbox-ipam.ipamvlangroupscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: ipamvlangroupsbulkupdate description: Put a list of VLAN group objects. call: netbox-ipam.ipamvlangroupsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamvlangroupsbulkpartialupdate description: Patch a list of VLAN group objects. call: netbox-ipam.ipamvlangroupsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamvlangroupsbulkdestroy description: Delete a list of VLAN group objects. call: netbox-ipam.ipamvlangroupsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/ipam/vlan-groups/{id} name: api-ipam-vlan-groups-id description: REST surface for api-ipam-vlan-groups-id. operations: - method: GET name: ipamvlangroupsretrieve description: Get a VLAN group object. call: netbox-ipam.ipamvlangroupsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: ipamvlangroupsupdate description: Put a VLAN group object. call: netbox-ipam.ipamvlangroupsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamvlangroupspartialupdate description: Patch a VLAN group object. call: netbox-ipam.ipamvlangroupspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamvlangroupsdestroy description: Delete a VLAN group object. call: netbox-ipam.ipamvlangroupsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/ipam/vlan-groups/{id}/available-vlans name: api-ipam-vlan-groups-id-available-vlans description: REST surface for api-ipam-vlan-groups-id-available-vlans. operations: - method: GET name: ipamvlangroupsavailablevlanslist description: Get a VLAN object. call: netbox-ipam.ipamvlangroupsavailablevlanslist with: id: rest.id outputParameters: - type: object mapping: $. - method: POST name: ipamvlangroupsavailablevlanscreate description: Post a VLAN object. call: netbox-ipam.ipamvlangroupsavailablevlanscreate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/ipam/vlan-translation-policies name: api-ipam-vlan-translation-policies description: REST surface for api-ipam-vlan-translation-policies. operations: - method: GET name: ipamvlantranslationpolicieslist description: Get a list of VLAN translation policy objects. call: netbox-ipam.ipamvlantranslationpolicieslist 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 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: ipamvlantranslationpoliciescreate description: Post a list of VLAN translation policy objects. call: netbox-ipam.ipamvlantranslationpoliciescreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: ipamvlantranslationpoliciesbulkupdate description: Put a list of VLAN translation policy objects. call: netbox-ipam.ipamvlantranslationpoliciesbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamvlantranslationpoliciesbulkpartialupdate description: Patch a list of VLAN translation policy objects. call: netbox-ipam.ipamvlantranslationpoliciesbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamvlantranslationpoliciesbulkdestroy description: Delete a list of VLAN translation policy objects. call: netbox-ipam.ipamvlantranslationpoliciesbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/ipam/vlan-translation-policies/{id} name: api-ipam-vlan-translation-policies-id description: REST surface for api-ipam-vlan-translation-policies-id. operations: - method: GET name: ipamvlantranslationpoliciesretrieve description: Get a VLAN translation policy object. call: netbox-ipam.ipamvlantranslationpoliciesretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: ipamvlantranslationpoliciesupdate description: Put a VLAN translation policy object. call: netbox-ipam.ipamvlantranslationpoliciesupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamvlantranslationpoliciespartialupdate description: Patch a VLAN translation policy object. call: netbox-ipam.ipamvlantranslationpoliciespartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamvlantranslationpoliciesdestroy description: Delete a VLAN translation policy object. call: netbox-ipam.ipamvlantranslationpoliciesdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/ipam/vlan-translation-rules name: api-ipam-vlan-translation-rules description: REST surface for api-ipam-vlan-translation-rules. operations: - method: GET name: ipamvlantranslationruleslist description: Get a list of VLAN translation rule objects. call: netbox-ipam.ipamvlantranslationruleslist 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 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 local_vid: rest.local_vid local_vid__empty: rest.local_vid__empty local_vid__gt: rest.local_vid__gt local_vid__gte: rest.local_vid__gte local_vid__lt: rest.local_vid__lt local_vid__lte: rest.local_vid__lte local_vid__n: rest.local_vid__n modified_by_request: rest.modified_by_request offset: rest.offset ordering: rest.ordering policy: rest.policy policy__n: rest.policy__n policy_id: rest.policy_id policy_id__n: rest.policy_id__n q: rest.q remote_vid: rest.remote_vid remote_vid__empty: rest.remote_vid__empty remote_vid__gt: rest.remote_vid__gt remote_vid__gte: rest.remote_vid__gte remote_vid__lt: rest.remote_vid__lt remote_vid__lte: rest.remote_vid__lte remote_vid__n: rest.remote_vid__n 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: ipamvlantranslationrulescreate description: Post a list of VLAN translation rule objects. call: netbox-ipam.ipamvlantranslationrulescreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: ipamvlantranslationrulesbulkupdate description: Put a list of VLAN translation rule objects. call: netbox-ipam.ipamvlantranslationrulesbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamvlantranslationrulesbulkpartialupdate description: Patch a list of VLAN translation rule objects. call: netbox-ipam.ipamvlantranslationrulesbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamvlantranslationrulesbulkdestroy description: Delete a list of VLAN translation rule objects. call: netbox-ipam.ipamvlantranslationrulesbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/ipam/vlan-translation-rules/{id} name: api-ipam-vlan-translation-rules-id description: REST surface for api-ipam-vlan-translation-rules-id. operations: - method: GET name: ipamvlantranslationrulesretrieve description: Get a VLAN translation rule object. call: netbox-ipam.ipamvlantranslationrulesretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: ipamvlantranslationrulesupdate description: Put a VLAN translation rule object. call: netbox-ipam.ipamvlantranslationrulesupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamvlantranslationrulespartialupdate description: Patch a VLAN translation rule object. call: netbox-ipam.ipamvlantranslationrulespartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamvlantranslationrulesdestroy description: Delete a VLAN translation rule object. call: netbox-ipam.ipamvlantranslationrulesdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/ipam/vlans name: api-ipam-vlans description: REST surface for api-ipam-vlans. operations: - method: GET name: ipamvlanslist description: Get a list of VLAN objects. call: netbox-ipam.ipamvlanslist with: available_at_site: rest.available_at_site available_on_device: rest.available_on_device available_on_virtualmachine: rest.available_on_virtualmachine 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 group: rest.group group__n: rest.group__n group_id: rest.group_id group_id__n: rest.group_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 interface_id: rest.interface_id l2vpn: rest.l2vpn l2vpn__n: rest.l2vpn__n l2vpn_id: rest.l2vpn_id l2vpn_id__n: rest.l2vpn_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 qinq_role: rest.qinq_role qinq_role__empty: rest.qinq_role__empty qinq_role__ic: rest.qinq_role__ic qinq_role__ie: rest.qinq_role__ie qinq_role__iew: rest.qinq_role__iew qinq_role__iregex: rest.qinq_role__iregex qinq_role__isw: rest.qinq_role__isw qinq_role__n: rest.qinq_role__n qinq_role__nic: rest.qinq_role__nic qinq_role__nie: rest.qinq_role__nie qinq_role__niew: rest.qinq_role__niew qinq_role__nisw: rest.qinq_role__nisw qinq_role__regex: rest.qinq_role__regex qinq_svlan_id: rest.qinq_svlan_id qinq_svlan_id__n: rest.qinq_svlan_id__n qinq_svlan_vid: rest.qinq_svlan_vid qinq_svlan_vid__empty: rest.qinq_svlan_vid__empty qinq_svlan_vid__gt: rest.qinq_svlan_vid__gt qinq_svlan_vid__gte: rest.qinq_svlan_vid__gte qinq_svlan_vid__lt: rest.qinq_svlan_vid__lt qinq_svlan_vid__lte: rest.qinq_svlan_vid__lte qinq_svlan_vid__n: rest.qinq_svlan_vid__n region: rest.region region__n: rest.region__n region_id: rest.region_id region_id__n: rest.region_id__n role: rest.role role__n: rest.role__n role_id: rest.role_id role_id__n: rest.role_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 status: rest.status status__empty: rest.status__empty status__ic: rest.status__ic status__ie: rest.status__ie status__iew: rest.status__iew status__iregex: rest.status__iregex status__isw: rest.status__isw status__n: rest.status__n status__nic: rest.status__nic status__nie: rest.status__nie status__niew: rest.status__niew status__nisw: rest.status__nisw status__regex: rest.status__regex 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 vid: rest.vid vid__empty: rest.vid__empty vid__gt: rest.vid__gt vid__gte: rest.vid__gte vid__lt: rest.vid__lt vid__lte: rest.vid__lte vid__n: rest.vid__n vminterface_id: rest.vminterface_id outputParameters: - type: object mapping: $. - method: POST name: ipamvlanscreate description: Post a list of VLAN objects. call: netbox-ipam.ipamvlanscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: ipamvlansbulkupdate description: Put a list of VLAN objects. call: netbox-ipam.ipamvlansbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamvlansbulkpartialupdate description: Patch a list of VLAN objects. call: netbox-ipam.ipamvlansbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamvlansbulkdestroy description: Delete a list of VLAN objects. call: netbox-ipam.ipamvlansbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/ipam/vlans/{id} name: api-ipam-vlans-id description: REST surface for api-ipam-vlans-id. operations: - method: GET name: ipamvlansretrieve description: Get a VLAN object. call: netbox-ipam.ipamvlansretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: ipamvlansupdate description: Put a VLAN object. call: netbox-ipam.ipamvlansupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamvlanspartialupdate description: Patch a VLAN object. call: netbox-ipam.ipamvlanspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamvlansdestroy description: Delete a VLAN object. call: netbox-ipam.ipamvlansdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/ipam/vrfs name: api-ipam-vrfs description: REST surface for api-ipam-vrfs. operations: - method: GET name: ipamvrfslist description: Get a list of VRF objects. call: netbox-ipam.ipamvrfslist 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 enforce_unique: rest.enforce_unique export_target: rest.export_target export_target__n: rest.export_target__n export_target_id: rest.export_target_id export_target_id__n: rest.export_target_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 import_target: rest.import_target import_target__n: rest.import_target__n import_target_id: rest.import_target_id import_target_id__n: rest.import_target_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 rd: rest.rd rd__empty: rest.rd__empty rd__ic: rest.rd__ic rd__ie: rest.rd__ie rd__iew: rest.rd__iew rd__iregex: rest.rd__iregex rd__isw: rest.rd__isw rd__n: rest.rd__n rd__nic: rest.rd__nic rd__nie: rest.rd__nie rd__niew: rest.rd__niew rd__nisw: rest.rd__nisw rd__regex: rest.rd__regex 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 outputParameters: - type: object mapping: $. - method: POST name: ipamvrfscreate description: Post a list of VRF objects. call: netbox-ipam.ipamvrfscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: ipamvrfsbulkupdate description: Put a list of VRF objects. call: netbox-ipam.ipamvrfsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamvrfsbulkpartialupdate description: Patch a list of VRF objects. call: netbox-ipam.ipamvrfsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamvrfsbulkdestroy description: Delete a list of VRF objects. call: netbox-ipam.ipamvrfsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/ipam/vrfs/{id} name: api-ipam-vrfs-id description: REST surface for api-ipam-vrfs-id. operations: - method: GET name: ipamvrfsretrieve description: Get a VRF object. call: netbox-ipam.ipamvrfsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: ipamvrfsupdate description: Put a VRF object. call: netbox-ipam.ipamvrfsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: ipamvrfspartialupdate description: Patch a VRF object. call: netbox-ipam.ipamvrfspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: ipamvrfsdestroy description: Delete a VRF object. call: netbox-ipam.ipamvrfsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - type: mcp namespace: netbox-ipam-mcp port: 9090 transport: http description: MCP adapter for NetBox REST API — ipam. One tool per consumed operation, routed inline through this capability's consumes block. tools: - name: get-list-aggregate-objects description: Get a list of aggregate objects. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamaggregateslist with: contact: tools.contact contact__n: tools.contact__n contact_group: tools.contact_group contact_group__n: tools.contact_group__n contact_role: tools.contact_role contact_role__n: tools.contact_role__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 date_added: tools.date_added date_added__empty: tools.date_added__empty date_added__gt: tools.date_added__gt date_added__gte: tools.date_added__gte date_added__lt: tools.date_added__lt date_added__lte: tools.date_added__lte date_added__n: tools.date_added__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 family: tools.family 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 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 prefix: tools.prefix q: tools.q rir: tools.rir rir__n: tools.rir__n rir_id: tools.rir_id rir_id__n: tools.rir_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 outputParameters: - type: object mapping: $. - name: post-list-aggregate-objects description: Post a list of aggregate objects. hints: readOnly: true destructive: false idempotent: false call: netbox-ipam.ipamaggregatescreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-aggregate-objects description: Put a list of aggregate objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamaggregatesbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-aggregate-objects description: Patch a list of aggregate objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamaggregatesbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-aggregate-objects description: Delete a list of aggregate objects. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamaggregatesbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-aggregate-object description: Get a aggregate object. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamaggregatesretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-aggregate-object description: Put a aggregate object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamaggregatesupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-aggregate-object description: Patch a aggregate object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamaggregatespartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-aggregate-object description: Delete a aggregate object. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamaggregatesdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-asn-range-objects description: Get a list of ASN range objects. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamasnrangeslist 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 end: tools.end end__empty: tools.end__empty end__gt: tools.end__gt end__gte: tools.end__gte end__lt: tools.end__lt end__lte: tools.end__lte end__n: tools.end__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 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 rir: tools.rir rir__n: tools.rir__n rir_id: tools.rir_id rir_id__n: tools.rir_id__n 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 start: tools.start start__empty: tools.start__empty start__gt: tools.start__gt start__gte: tools.start__gte start__lt: tools.start__lt start__lte: tools.start__lte start__n: tools.start__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 outputParameters: - type: object mapping: $. - name: post-list-asn-range-objects description: Post a list of ASN range objects. hints: readOnly: true destructive: false idempotent: false call: netbox-ipam.ipamasnrangescreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-asn-range-objects description: Put a list of ASN range objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamasnrangesbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-asn-range-objects description: Patch a list of ASN range objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamasnrangesbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-asn-range-objects description: Delete a list of ASN range objects. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamasnrangesbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-asn-range-object description: Get a ASN range object. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamasnrangesretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-asn-range-object description: Put a ASN range object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamasnrangesupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-asn-range-object description: Patch a ASN range object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamasnrangespartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-asn-range-object description: Delete a ASN range object. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamasnrangesdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-asn-object description: Get a ASN object. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamasnrangesavailableasnslist with: id: tools.id outputParameters: - type: object mapping: $. - name: post-asn-object description: Post a ASN object. hints: readOnly: false destructive: false idempotent: false call: netbox-ipam.ipamasnrangesavailableasnscreate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: get-list-asn-objects description: Get a list of ASN objects. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamasnslist with: asn: tools.asn asn__empty: tools.asn__empty asn__gt: tools.asn__gt asn__gte: tools.asn__gte asn__lt: tools.asn__lt asn__lte: tools.asn__lte asn__n: tools.asn__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 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 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 provider: tools.provider provider__n: tools.provider__n provider_id: tools.provider_id provider_id__n: tools.provider_id__n q: tools.q rir: tools.rir rir__n: tools.rir__n rir_id: tools.rir_id rir_id__n: tools.rir_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 outputParameters: - type: object mapping: $. - name: post-list-asn-objects description: Post a list of ASN objects. hints: readOnly: true destructive: false idempotent: false call: netbox-ipam.ipamasnscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-asn-objects description: Put a list of ASN objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamasnsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-asn-objects description: Patch a list of ASN objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamasnsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-asn-objects description: Delete a list of ASN objects. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamasnsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-asn-object-2 description: Get a ASN object. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamasnsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-asn-object description: Put a ASN object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamasnsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-asn-object description: Patch a ASN object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamasnspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-asn-object description: Delete a ASN object. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamasnsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-fhrp-group-assignment description: Get a list of FHRP group assignment objects. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamfhrpgroupassignmentslist 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 device: tools.device device_id: tools.device_id group_id: tools.group_id group_id__n: tools.group_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 interface_id: tools.interface_id interface_id__empty: tools.interface_id__empty interface_id__gt: tools.interface_id__gt interface_id__gte: tools.interface_id__gte interface_id__lt: tools.interface_id__lt interface_id__lte: tools.interface_id__lte interface_id__n: tools.interface_id__n interface_type: tools.interface_type interface_type__n: tools.interface_type__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 offset: tools.offset ordering: tools.ordering priority: tools.priority priority__empty: tools.priority__empty priority__gt: tools.priority__gt priority__gte: tools.priority__gte priority__lt: tools.priority__lt priority__lte: tools.priority__lte priority__n: tools.priority__n updated_by_request: tools.updated_by_request virtual_machine: tools.virtual_machine virtual_machine_id: tools.virtual_machine_id outputParameters: - type: object mapping: $. - name: post-list-fhrp-group-assignment description: Post a list of FHRP group assignment objects. hints: readOnly: true destructive: false idempotent: false call: netbox-ipam.ipamfhrpgroupassignmentscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-fhrp-group-assignment description: Put a list of FHRP group assignment objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamfhrpgroupassignmentsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-fhrp-group-assignment description: Patch a list of FHRP group assignment objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamfhrpgroupassignmentsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-fhrp-group-assignment description: Delete a list of FHRP group assignment objects. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamfhrpgroupassignmentsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-fhrp-group-assignment-object description: Get a FHRP group assignment object. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamfhrpgroupassignmentsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-fhrp-group-assignment-object description: Put a FHRP group assignment object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamfhrpgroupassignmentsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-fhrp-group-assignment-object description: Patch a FHRP group assignment object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamfhrpgroupassignmentspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-fhrp-group-assignment-object description: Delete a FHRP group assignment object. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamfhrpgroupassignmentsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-fhrp-group-objects description: Get a list of FHRP group objects. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamfhrpgroupslist with: auth_key: tools.auth_key auth_key__empty: tools.auth_key__empty auth_key__ic: tools.auth_key__ic auth_key__ie: tools.auth_key__ie auth_key__iew: tools.auth_key__iew auth_key__iregex: tools.auth_key__iregex auth_key__isw: tools.auth_key__isw auth_key__n: tools.auth_key__n auth_key__nic: tools.auth_key__nic auth_key__nie: tools.auth_key__nie auth_key__niew: tools.auth_key__niew auth_key__nisw: tools.auth_key__nisw auth_key__regex: tools.auth_key__regex auth_type: tools.auth_type auth_type__empty: tools.auth_type__empty auth_type__ic: tools.auth_type__ic auth_type__ie: tools.auth_type__ie auth_type__iew: tools.auth_type__iew auth_type__iregex: tools.auth_type__iregex auth_type__isw: tools.auth_type__isw auth_type__n: tools.auth_type__n auth_type__nic: tools.auth_type__nic auth_type__nie: tools.auth_type__nie auth_type__niew: tools.auth_type__niew auth_type__nisw: tools.auth_type__nisw auth_type__regex: tools.auth_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 group_id: tools.group_id group_id__empty: tools.group_id__empty group_id__gt: tools.group_id__gt group_id__gte: tools.group_id__gte group_id__lt: tools.group_id__lt group_id__lte: tools.group_id__lte group_id__n: tools.group_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 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 protocol: tools.protocol protocol__empty: tools.protocol__empty protocol__ic: tools.protocol__ic protocol__ie: tools.protocol__ie protocol__iew: tools.protocol__iew protocol__iregex: tools.protocol__iregex protocol__isw: tools.protocol__isw protocol__n: tools.protocol__n protocol__nic: tools.protocol__nic protocol__nie: tools.protocol__nie protocol__niew: tools.protocol__niew protocol__nisw: tools.protocol__nisw protocol__regex: tools.protocol__regex q: tools.q related_ip: tools.related_ip 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-fhrp-group-objects description: Post a list of FHRP group objects. hints: readOnly: true destructive: false idempotent: false call: netbox-ipam.ipamfhrpgroupscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-fhrp-group-objects description: Put a list of FHRP group objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamfhrpgroupsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-fhrp-group-objects description: Patch a list of FHRP group objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamfhrpgroupsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-fhrp-group-objects description: Delete a list of FHRP group objects. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamfhrpgroupsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-fhrp-group-object description: Get a FHRP group object. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamfhrpgroupsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-fhrp-group-object description: Put a FHRP group object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamfhrpgroupsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-fhrp-group-object description: Patch a FHRP group object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamfhrpgroupspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-fhrp-group-object description: Delete a FHRP group object. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamfhrpgroupsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-ip-address-objects description: Get a list of IP address objects. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamipaddresseslist with: address: tools.address assigned: tools.assigned 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_to_interface: tools.assigned_to_interface contact: tools.contact contact__n: tools.contact__n contact_group: tools.contact_group contact_group__n: tools.contact_group__n contact_role: tools.contact_role contact_role__n: tools.contact_role__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 device: tools.device device_id: tools.device_id dns_name: tools.dns_name dns_name__empty: tools.dns_name__empty dns_name__ic: tools.dns_name__ic dns_name__ie: tools.dns_name__ie dns_name__iew: tools.dns_name__iew dns_name__iregex: tools.dns_name__iregex dns_name__isw: tools.dns_name__isw dns_name__n: tools.dns_name__n dns_name__nic: tools.dns_name__nic dns_name__nie: tools.dns_name__nie dns_name__niew: tools.dns_name__niew dns_name__nisw: tools.dns_name__nisw dns_name__regex: tools.dns_name__regex family: tools.family fhrpgroup_id: tools.fhrpgroup_id fhrpgroup_id__n: tools.fhrpgroup_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 interface: tools.interface interface__n: tools.interface__n interface_id: tools.interface_id interface_id__n: tools.interface_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 mask_length: tools.mask_length mask_length__gte: tools.mask_length__gte mask_length__lte: tools.mask_length__lte modified_by_request: tools.modified_by_request nat_inside_id: tools.nat_inside_id nat_inside_id__n: tools.nat_inside_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 parent: tools.parent present_in_vrf: tools.present_in_vrf present_in_vrf_id: tools.present_in_vrf_id q: tools.q role: tools.role role__empty: tools.role__empty role__ic: tools.role__ic role__ie: tools.role__ie role__iew: tools.role__iew role__iregex: tools.role__iregex role__isw: tools.role__isw role__n: tools.role__n role__nic: tools.role__nic role__nie: tools.role__nie role__niew: tools.role__niew role__nisw: tools.role__nisw role__regex: tools.role__regex service_id: tools.service_id service_id__n: tools.service_id__n status: tools.status status__empty: tools.status__empty status__ic: tools.status__ic status__ie: tools.status__ie status__iew: tools.status__iew status__iregex: tools.status__iregex status__isw: tools.status__isw status__n: tools.status__n status__nic: tools.status__nic status__nie: tools.status__nie status__niew: tools.status__niew status__nisw: tools.status__nisw status__regex: tools.status__regex 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 virtual_machine: tools.virtual_machine virtual_machine_id: tools.virtual_machine_id vminterface: tools.vminterface vminterface__n: tools.vminterface__n vminterface_id: tools.vminterface_id vminterface_id__n: tools.vminterface_id__n vrf: tools.vrf vrf__n: tools.vrf__n vrf_id: tools.vrf_id vrf_id__n: tools.vrf_id__n outputParameters: - type: object mapping: $. - name: post-list-ip-address-objects description: Post a list of IP address objects. hints: readOnly: true destructive: false idempotent: false call: netbox-ipam.ipamipaddressescreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-ip-address-objects description: Put a list of IP address objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamipaddressesbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-ip-address-objects description: Patch a list of IP address objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamipaddressesbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-ip-address-objects description: Delete a list of IP address objects. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamipaddressesbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-ip-address-object description: Get a IP address object. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamipaddressesretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-ip-address-object description: Put a IP address object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamipaddressesupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-ip-address-object description: Patch a IP address object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamipaddressespartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-ip-address-object description: Delete a IP address object. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamipaddressesdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-ip-range-objects description: Get a list of IP range objects. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamiprangeslist with: contact: tools.contact contact__n: tools.contact__n contact_group: tools.contact_group contact_group__n: tools.contact_group__n contact_role: tools.contact_role contact_role__n: tools.contact_role__n contains: tools.contains 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 end_address: tools.end_address family: tools.family 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 mark_populated: tools.mark_populated mark_utilized: tools.mark_utilized modified_by_request: tools.modified_by_request 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 parent: tools.parent q: tools.q role: tools.role role__n: tools.role__n role_id: tools.role_id role_id__n: tools.role_id__n size: tools.size size__empty: tools.size__empty size__gt: tools.size__gt size__gte: tools.size__gte size__lt: tools.size__lt size__lte: tools.size__lte size__n: tools.size__n start_address: tools.start_address status: tools.status status__empty: tools.status__empty status__ic: tools.status__ic status__ie: tools.status__ie status__iew: tools.status__iew status__iregex: tools.status__iregex status__isw: tools.status__isw status__n: tools.status__n status__nic: tools.status__nic status__nie: tools.status__nie status__niew: tools.status__niew status__nisw: tools.status__nisw status__regex: tools.status__regex 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 vrf: tools.vrf vrf__n: tools.vrf__n vrf_id: tools.vrf_id vrf_id__n: tools.vrf_id__n outputParameters: - type: object mapping: $. - name: post-list-ip-range-objects description: Post a list of IP range objects. hints: readOnly: true destructive: false idempotent: false call: netbox-ipam.ipamiprangescreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-ip-range-objects description: Put a list of IP range objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamiprangesbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-ip-range-objects description: Patch a list of IP range objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamiprangesbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-ip-range-objects description: Delete a list of IP range objects. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamiprangesbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-ip-range-object description: Get a IP range object. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamiprangesretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-ip-range-object description: Put a IP range object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamiprangesupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-ip-range-object description: Patch a IP range object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamiprangespartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-ip-range-object description: Delete a IP range object. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamiprangesdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-ip-address-object-2 description: Get a IP address object. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamiprangesavailableipslist with: id: tools.id outputParameters: - type: object mapping: $. - name: post-ip-address-object description: Post a IP address object. hints: readOnly: false destructive: false idempotent: false call: netbox-ipam.ipamiprangesavailableipscreate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: get-list-prefix-objects description: Get a list of prefix objects. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamprefixeslist with: children: tools.children children__empty: tools.children__empty children__gt: tools.children__gt children__gte: tools.children__gte children__lt: tools.children__lt children__lte: tools.children__lte children__n: tools.children__n contact: tools.contact contact__n: tools.contact__n contact_group: tools.contact_group contact_group__n: tools.contact_group__n contact_role: tools.contact_role contact_role__n: tools.contact_role__n contains: tools.contains 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 depth: tools.depth depth__empty: tools.depth__empty depth__gt: tools.depth__gt depth__gte: tools.depth__gte depth__lt: tools.depth__lt depth__lte: tools.depth__lte depth__n: tools.depth__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 family: tools.family 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_pool: tools.is_pool 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 mark_utilized: tools.mark_utilized mask_length: tools.mask_length mask_length__gte: tools.mask_length__gte mask_length__lte: tools.mask_length__lte modified_by_request: tools.modified_by_request 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 prefix: tools.prefix present_in_vrf: tools.present_in_vrf present_in_vrf_id: tools.present_in_vrf_id q: tools.q region: tools.region region__n: tools.region__n region_id: tools.region_id region_id__n: tools.region_id__n role: tools.role role__n: tools.role__n role_id: tools.role_id role_id__n: tools.role_id__n scope_id: tools.scope_id scope_id__empty: tools.scope_id__empty scope_id__gt: tools.scope_id__gt scope_id__gte: tools.scope_id__gte scope_id__lt: tools.scope_id__lt scope_id__lte: tools.scope_id__lte scope_id__n: tools.scope_id__n scope_type: tools.scope_type scope_type__n: tools.scope_type__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 status: tools.status status__empty: tools.status__empty status__ic: tools.status__ic status__ie: tools.status__ie status__iew: tools.status__iew status__iregex: tools.status__iregex status__isw: tools.status__isw status__n: tools.status__n status__nic: tools.status__nic status__nie: tools.status__nie status__niew: tools.status__niew status__nisw: tools.status__nisw status__regex: tools.status__regex 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 vlan_group: tools.vlan_group vlan_group__n: tools.vlan_group__n vlan_group_id: tools.vlan_group_id vlan_group_id__n: tools.vlan_group_id__n vlan_id: tools.vlan_id vlan_id__n: tools.vlan_id__n vlan_vid: tools.vlan_vid vlan_vid__empty: tools.vlan_vid__empty vlan_vid__gt: tools.vlan_vid__gt vlan_vid__gte: tools.vlan_vid__gte vlan_vid__lt: tools.vlan_vid__lt vlan_vid__lte: tools.vlan_vid__lte vlan_vid__n: tools.vlan_vid__n vrf: tools.vrf vrf__n: tools.vrf__n vrf_id: tools.vrf_id vrf_id__n: tools.vrf_id__n within: tools.within within_include: tools.within_include outputParameters: - type: object mapping: $. - name: post-list-prefix-objects description: Post a list of prefix objects. hints: readOnly: true destructive: false idempotent: false call: netbox-ipam.ipamprefixescreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-prefix-objects description: Put a list of prefix objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamprefixesbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-prefix-objects description: Patch a list of prefix objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamprefixesbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-prefix-objects description: Delete a list of prefix objects. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamprefixesbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-prefix-object description: Get a prefix object. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamprefixesretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-prefix-object description: Put a prefix object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamprefixesupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-prefix-object description: Patch a prefix object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamprefixespartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-prefix-object description: Delete a prefix object. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamprefixesdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-ip-address-object-3 description: Get a IP address object. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamprefixesavailableipslist with: id: tools.id outputParameters: - type: object mapping: $. - name: post-ip-address-object-2 description: Post a IP address object. hints: readOnly: false destructive: false idempotent: false call: netbox-ipam.ipamprefixesavailableipscreate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: get-prefix-object-2 description: Get a prefix object. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamprefixesavailableprefixeslist with: id: tools.id outputParameters: - type: object mapping: $. - name: post-prefix-object description: Post a prefix object. hints: readOnly: false destructive: false idempotent: false call: netbox-ipam.ipamprefixesavailableprefixescreate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: get-list-rir-objects description: Get a list of RIR objects. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamrirslist 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 is_private: tools.is_private 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 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 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-rir-objects description: Post a list of RIR objects. hints: readOnly: true destructive: false idempotent: false call: netbox-ipam.ipamrirscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-rir-objects description: Put a list of RIR objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamrirsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-rir-objects description: Patch a list of RIR objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamrirsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-rir-objects description: Delete a list of RIR objects. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamrirsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-rir-object description: Get a RIR object. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamrirsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-rir-object description: Put a RIR object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamrirsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-rir-object description: Patch a RIR object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamrirspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-rir-object description: Delete a RIR object. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamrirsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-role-objects description: Get a list of role objects. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamroleslist 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 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 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 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 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-role-objects description: Post a list of role objects. hints: readOnly: true destructive: false idempotent: false call: netbox-ipam.ipamrolescreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-role-objects description: Put a list of role objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamrolesbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-role-objects description: Patch a list of role objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamrolesbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-role-objects description: Delete a list of role objects. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamrolesbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-role-object description: Get a role object. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamrolesretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-role-object description: Put a role object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamrolesupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-role-object description: Patch a role object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamrolespartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-role-object description: Delete a role object. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamrolesdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-route-target-objects description: Get a list of route target objects. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamroutetargetslist 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 exporting_l2vpn: tools.exporting_l2vpn exporting_l2vpn__n: tools.exporting_l2vpn__n exporting_l2vpn_id: tools.exporting_l2vpn_id exporting_l2vpn_id__n: tools.exporting_l2vpn_id__n exporting_vrf: tools.exporting_vrf exporting_vrf__n: tools.exporting_vrf__n exporting_vrf_id: tools.exporting_vrf_id exporting_vrf_id__n: tools.exporting_vrf_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 importing_l2vpn: tools.importing_l2vpn importing_l2vpn__n: tools.importing_l2vpn__n importing_l2vpn_id: tools.importing_l2vpn_id importing_l2vpn_id__n: tools.importing_l2vpn_id__n importing_vrf: tools.importing_vrf importing_vrf__n: tools.importing_vrf__n importing_vrf_id: tools.importing_vrf_id importing_vrf_id__n: tools.importing_vrf_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 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 outputParameters: - type: object mapping: $. - name: post-list-route-target-objects description: Post a list of route target objects. hints: readOnly: true destructive: false idempotent: false call: netbox-ipam.ipamroutetargetscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-route-target-objects description: Put a list of route target objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamroutetargetsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-route-target-objects description: Patch a list of route target objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamroutetargetsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-route-target-objects description: Delete a list of route target objects. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamroutetargetsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-route-target-object description: Get a route target object. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamroutetargetsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-route-target-object description: Put a route target object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamroutetargetsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-route-target-object description: Patch a route target object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamroutetargetspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-route-target-object description: Delete a route target object. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamroutetargetsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-application-service-template description: Get a list of application service template objects. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamservicetemplateslist 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 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 port: tools.port port__empty: tools.port__empty port__gt: tools.port__gt port__gte: tools.port__gte port__lt: tools.port__lt port__lte: tools.port__lte port__n: tools.port__n protocol: tools.protocol protocol__empty: tools.protocol__empty protocol__ic: tools.protocol__ic protocol__ie: tools.protocol__ie protocol__iew: tools.protocol__iew protocol__iregex: tools.protocol__iregex protocol__isw: tools.protocol__isw protocol__n: tools.protocol__n protocol__nic: tools.protocol__nic protocol__nie: tools.protocol__nie protocol__niew: tools.protocol__niew protocol__nisw: tools.protocol__nisw protocol__regex: tools.protocol__regex 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-application-service-template description: Post a list of application service template objects. hints: readOnly: true destructive: false idempotent: false call: netbox-ipam.ipamservicetemplatescreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-application-service-template description: Put a list of application service template objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamservicetemplatesbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-application-service-template description: Patch a list of application service template objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamservicetemplatesbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-application-service-template description: Delete a list of application service template objects. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamservicetemplatesbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-application-service-template-object description: Get a application service template object. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamservicetemplatesretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-application-service-template-object description: Put a application service template object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamservicetemplatesupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-application-service-template-object description: Patch a application service template object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamservicetemplatespartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-application-service-template-object description: Delete a application service template object. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamservicetemplatesdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-application-service-objects description: Get a list of application service objects. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamserviceslist with: contact: tools.contact contact__n: tools.contact__n contact_group: tools.contact_group contact_group__n: tools.contact_group__n contact_role: tools.contact_role contact_role__n: tools.contact_role__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 device: tools.device device_id: tools.device_id fhrpgroup: tools.fhrpgroup fhrpgroup_id: tools.fhrpgroup_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 ip_address: tools.ip_address ip_address__n: tools.ip_address__n ip_address_id: tools.ip_address_id ip_address_id__n: tools.ip_address_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 parent_object_id: tools.parent_object_id parent_object_id__empty: tools.parent_object_id__empty parent_object_id__gt: tools.parent_object_id__gt parent_object_id__gte: tools.parent_object_id__gte parent_object_id__lt: tools.parent_object_id__lt parent_object_id__lte: tools.parent_object_id__lte parent_object_id__n: tools.parent_object_id__n parent_object_type: tools.parent_object_type parent_object_type__n: tools.parent_object_type__n port: tools.port port__empty: tools.port__empty port__gt: tools.port__gt port__gte: tools.port__gte port__lt: tools.port__lt port__lte: tools.port__lte port__n: tools.port__n protocol: tools.protocol protocol__empty: tools.protocol__empty protocol__ic: tools.protocol__ic protocol__ie: tools.protocol__ie protocol__iew: tools.protocol__iew protocol__iregex: tools.protocol__iregex protocol__isw: tools.protocol__isw protocol__n: tools.protocol__n protocol__nic: tools.protocol__nic protocol__nie: tools.protocol__nie protocol__niew: tools.protocol__niew protocol__nisw: tools.protocol__nisw protocol__regex: tools.protocol__regex 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 virtual_machine: tools.virtual_machine virtual_machine_id: tools.virtual_machine_id outputParameters: - type: object mapping: $. - name: post-list-application-service-objects description: Post a list of application service objects. hints: readOnly: true destructive: false idempotent: false call: netbox-ipam.ipamservicescreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-application-service-objects description: Put a list of application service objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamservicesbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-application-service-objects description: Patch a list of application service objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamservicesbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-application-service-objects description: Delete a list of application service objects. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamservicesbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-application-service-object description: Get a application service object. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamservicesretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-application-service-object description: Put a application service object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamservicesupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-application-service-object description: Patch a application service object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamservicespartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-application-service-object description: Delete a application service object. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamservicesdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-vlan-group-objects description: Get a list of VLAN group objects. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamvlangroupslist with: cluster: tools.cluster cluster_group: tools.cluster_group contains_vid: tools.contains_vid 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 location: tools.location 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 rack: tools.rack region: tools.region scope_id: tools.scope_id scope_id__empty: tools.scope_id__empty scope_id__gt: tools.scope_id__gt scope_id__gte: tools.scope_id__gte scope_id__lt: tools.scope_id__lt scope_id__lte: tools.scope_id__lte scope_id__n: tools.scope_id__n scope_type: tools.scope_type scope_type__n: tools.scope_type__n site: tools.site site_group: tools.site_group 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 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 outputParameters: - type: object mapping: $. - name: post-list-vlan-group-objects description: Post a list of VLAN group objects. hints: readOnly: true destructive: false idempotent: false call: netbox-ipam.ipamvlangroupscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-vlan-group-objects description: Put a list of VLAN group objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamvlangroupsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-vlan-group-objects description: Patch a list of VLAN group objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamvlangroupsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-vlan-group-objects description: Delete a list of VLAN group objects. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamvlangroupsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-vlan-group-object description: Get a VLAN group object. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamvlangroupsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-vlan-group-object description: Put a VLAN group object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamvlangroupsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-vlan-group-object description: Patch a VLAN group object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamvlangroupspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-vlan-group-object description: Delete a VLAN group object. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamvlangroupsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-vlan-object description: Get a VLAN object. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamvlangroupsavailablevlanslist with: id: tools.id outputParameters: - type: object mapping: $. - name: post-vlan-object description: Post a VLAN object. hints: readOnly: false destructive: false idempotent: false call: netbox-ipam.ipamvlangroupsavailablevlanscreate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: get-list-vlan-translation-policy description: Get a list of VLAN translation policy objects. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamvlantranslationpolicieslist 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 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-vlan-translation-policy description: Post a list of VLAN translation policy objects. hints: readOnly: true destructive: false idempotent: false call: netbox-ipam.ipamvlantranslationpoliciescreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-vlan-translation-policy description: Put a list of VLAN translation policy objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamvlantranslationpoliciesbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-vlan-translation-policy description: Patch a list of VLAN translation policy objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamvlantranslationpoliciesbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-vlan-translation-policy description: Delete a list of VLAN translation policy objects. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamvlantranslationpoliciesbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-vlan-translation-policy-object description: Get a VLAN translation policy object. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamvlantranslationpoliciesretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-vlan-translation-policy-object description: Put a VLAN translation policy object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamvlantranslationpoliciesupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-vlan-translation-policy-object description: Patch a VLAN translation policy object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamvlantranslationpoliciespartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-vlan-translation-policy-object description: Delete a VLAN translation policy object. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamvlantranslationpoliciesdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-vlan-translation-rule description: Get a list of VLAN translation rule objects. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamvlantranslationruleslist 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 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 local_vid: tools.local_vid local_vid__empty: tools.local_vid__empty local_vid__gt: tools.local_vid__gt local_vid__gte: tools.local_vid__gte local_vid__lt: tools.local_vid__lt local_vid__lte: tools.local_vid__lte local_vid__n: tools.local_vid__n modified_by_request: tools.modified_by_request offset: tools.offset ordering: tools.ordering policy: tools.policy policy__n: tools.policy__n policy_id: tools.policy_id policy_id__n: tools.policy_id__n q: tools.q remote_vid: tools.remote_vid remote_vid__empty: tools.remote_vid__empty remote_vid__gt: tools.remote_vid__gt remote_vid__gte: tools.remote_vid__gte remote_vid__lt: tools.remote_vid__lt remote_vid__lte: tools.remote_vid__lte remote_vid__n: tools.remote_vid__n 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-vlan-translation-rule description: Post a list of VLAN translation rule objects. hints: readOnly: true destructive: false idempotent: false call: netbox-ipam.ipamvlantranslationrulescreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-vlan-translation-rule description: Put a list of VLAN translation rule objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamvlantranslationrulesbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-vlan-translation-rule description: Patch a list of VLAN translation rule objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamvlantranslationrulesbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-vlan-translation-rule description: Delete a list of VLAN translation rule objects. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamvlantranslationrulesbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-vlan-translation-rule-object description: Get a VLAN translation rule object. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamvlantranslationrulesretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-vlan-translation-rule-object description: Put a VLAN translation rule object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamvlantranslationrulesupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-vlan-translation-rule-object description: Patch a VLAN translation rule object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamvlantranslationrulespartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-vlan-translation-rule-object description: Delete a VLAN translation rule object. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamvlantranslationrulesdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-vlan-objects description: Get a list of VLAN objects. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamvlanslist with: available_at_site: tools.available_at_site available_on_device: tools.available_on_device available_on_virtualmachine: tools.available_on_virtualmachine 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 group: tools.group group__n: tools.group__n group_id: tools.group_id group_id__n: tools.group_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 interface_id: tools.interface_id l2vpn: tools.l2vpn l2vpn__n: tools.l2vpn__n l2vpn_id: tools.l2vpn_id l2vpn_id__n: tools.l2vpn_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 qinq_role: tools.qinq_role qinq_role__empty: tools.qinq_role__empty qinq_role__ic: tools.qinq_role__ic qinq_role__ie: tools.qinq_role__ie qinq_role__iew: tools.qinq_role__iew qinq_role__iregex: tools.qinq_role__iregex qinq_role__isw: tools.qinq_role__isw qinq_role__n: tools.qinq_role__n qinq_role__nic: tools.qinq_role__nic qinq_role__nie: tools.qinq_role__nie qinq_role__niew: tools.qinq_role__niew qinq_role__nisw: tools.qinq_role__nisw qinq_role__regex: tools.qinq_role__regex qinq_svlan_id: tools.qinq_svlan_id qinq_svlan_id__n: tools.qinq_svlan_id__n qinq_svlan_vid: tools.qinq_svlan_vid qinq_svlan_vid__empty: tools.qinq_svlan_vid__empty qinq_svlan_vid__gt: tools.qinq_svlan_vid__gt qinq_svlan_vid__gte: tools.qinq_svlan_vid__gte qinq_svlan_vid__lt: tools.qinq_svlan_vid__lt qinq_svlan_vid__lte: tools.qinq_svlan_vid__lte qinq_svlan_vid__n: tools.qinq_svlan_vid__n region: tools.region region__n: tools.region__n region_id: tools.region_id region_id__n: tools.region_id__n role: tools.role role__n: tools.role__n role_id: tools.role_id role_id__n: tools.role_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 status: tools.status status__empty: tools.status__empty status__ic: tools.status__ic status__ie: tools.status__ie status__iew: tools.status__iew status__iregex: tools.status__iregex status__isw: tools.status__isw status__n: tools.status__n status__nic: tools.status__nic status__nie: tools.status__nie status__niew: tools.status__niew status__nisw: tools.status__nisw status__regex: tools.status__regex 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 vid: tools.vid vid__empty: tools.vid__empty vid__gt: tools.vid__gt vid__gte: tools.vid__gte vid__lt: tools.vid__lt vid__lte: tools.vid__lte vid__n: tools.vid__n vminterface_id: tools.vminterface_id outputParameters: - type: object mapping: $. - name: post-list-vlan-objects description: Post a list of VLAN objects. hints: readOnly: true destructive: false idempotent: false call: netbox-ipam.ipamvlanscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-vlan-objects description: Put a list of VLAN objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamvlansbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-vlan-objects description: Patch a list of VLAN objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamvlansbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-vlan-objects description: Delete a list of VLAN objects. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamvlansbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-vlan-object-2 description: Get a VLAN object. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamvlansretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-vlan-object description: Put a VLAN object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamvlansupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-vlan-object description: Patch a VLAN object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamvlanspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-vlan-object description: Delete a VLAN object. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamvlansdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-vrf-objects description: Get a list of VRF objects. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamvrfslist 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 enforce_unique: tools.enforce_unique export_target: tools.export_target export_target__n: tools.export_target__n export_target_id: tools.export_target_id export_target_id__n: tools.export_target_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 import_target: tools.import_target import_target__n: tools.import_target__n import_target_id: tools.import_target_id import_target_id__n: tools.import_target_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 rd: tools.rd rd__empty: tools.rd__empty rd__ic: tools.rd__ic rd__ie: tools.rd__ie rd__iew: tools.rd__iew rd__iregex: tools.rd__iregex rd__isw: tools.rd__isw rd__n: tools.rd__n rd__nic: tools.rd__nic rd__nie: tools.rd__nie rd__niew: tools.rd__niew rd__nisw: tools.rd__nisw rd__regex: tools.rd__regex 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 outputParameters: - type: object mapping: $. - name: post-list-vrf-objects description: Post a list of VRF objects. hints: readOnly: true destructive: false idempotent: false call: netbox-ipam.ipamvrfscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-vrf-objects description: Put a list of VRF objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamvrfsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-vrf-objects description: Patch a list of VRF objects. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamvrfsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-vrf-objects description: Delete a list of VRF objects. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamvrfsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-vrf-object description: Get a VRF object. hints: readOnly: true destructive: false idempotent: true call: netbox-ipam.ipamvrfsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-vrf-object description: Put a VRF object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamvrfsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-vrf-object description: Patch a VRF object. hints: readOnly: false destructive: false idempotent: true call: netbox-ipam.ipamvrfspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-vrf-object description: Delete a VRF object. hints: readOnly: false destructive: true idempotent: true call: netbox-ipam.ipamvrfsdestroy with: id: tools.id outputParameters: - type: object mapping: $.