nautobot-openapi 0.2.0

# \CircuitsApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**circuits_circuit_terminations_bulk_destroy**](CircuitsApi.md#circuits_circuit_terminations_bulk_destroy) | **DELETE** /circuits/circuit-terminations/ | 
[**circuits_circuit_terminations_bulk_partial_update**](CircuitsApi.md#circuits_circuit_terminations_bulk_partial_update) | **PATCH** /circuits/circuit-terminations/ | 
[**circuits_circuit_terminations_bulk_update**](CircuitsApi.md#circuits_circuit_terminations_bulk_update) | **PUT** /circuits/circuit-terminations/ | 
[**circuits_circuit_terminations_create**](CircuitsApi.md#circuits_circuit_terminations_create) | **POST** /circuits/circuit-terminations/ | 
[**circuits_circuit_terminations_destroy**](CircuitsApi.md#circuits_circuit_terminations_destroy) | **DELETE** /circuits/circuit-terminations/{id}/ | 
[**circuits_circuit_terminations_list**](CircuitsApi.md#circuits_circuit_terminations_list) | **GET** /circuits/circuit-terminations/ | 
[**circuits_circuit_terminations_notes_create**](CircuitsApi.md#circuits_circuit_terminations_notes_create) | **POST** /circuits/circuit-terminations/{id}/notes/ | 
[**circuits_circuit_terminations_notes_list**](CircuitsApi.md#circuits_circuit_terminations_notes_list) | **GET** /circuits/circuit-terminations/{id}/notes/ | 
[**circuits_circuit_terminations_partial_update**](CircuitsApi.md#circuits_circuit_terminations_partial_update) | **PATCH** /circuits/circuit-terminations/{id}/ | 
[**circuits_circuit_terminations_retrieve**](CircuitsApi.md#circuits_circuit_terminations_retrieve) | **GET** /circuits/circuit-terminations/{id}/ | 
[**circuits_circuit_terminations_trace_retrieve**](CircuitsApi.md#circuits_circuit_terminations_trace_retrieve) | **GET** /circuits/circuit-terminations/{id}/trace/ | 
[**circuits_circuit_terminations_update**](CircuitsApi.md#circuits_circuit_terminations_update) | **PUT** /circuits/circuit-terminations/{id}/ | 
[**circuits_circuit_types_bulk_destroy**](CircuitsApi.md#circuits_circuit_types_bulk_destroy) | **DELETE** /circuits/circuit-types/ | 
[**circuits_circuit_types_bulk_partial_update**](CircuitsApi.md#circuits_circuit_types_bulk_partial_update) | **PATCH** /circuits/circuit-types/ | 
[**circuits_circuit_types_bulk_update**](CircuitsApi.md#circuits_circuit_types_bulk_update) | **PUT** /circuits/circuit-types/ | 
[**circuits_circuit_types_create**](CircuitsApi.md#circuits_circuit_types_create) | **POST** /circuits/circuit-types/ | 
[**circuits_circuit_types_destroy**](CircuitsApi.md#circuits_circuit_types_destroy) | **DELETE** /circuits/circuit-types/{id}/ | 
[**circuits_circuit_types_list**](CircuitsApi.md#circuits_circuit_types_list) | **GET** /circuits/circuit-types/ | 
[**circuits_circuit_types_notes_create**](CircuitsApi.md#circuits_circuit_types_notes_create) | **POST** /circuits/circuit-types/{id}/notes/ | 
[**circuits_circuit_types_notes_list**](CircuitsApi.md#circuits_circuit_types_notes_list) | **GET** /circuits/circuit-types/{id}/notes/ | 
[**circuits_circuit_types_partial_update**](CircuitsApi.md#circuits_circuit_types_partial_update) | **PATCH** /circuits/circuit-types/{id}/ | 
[**circuits_circuit_types_retrieve**](CircuitsApi.md#circuits_circuit_types_retrieve) | **GET** /circuits/circuit-types/{id}/ | 
[**circuits_circuit_types_update**](CircuitsApi.md#circuits_circuit_types_update) | **PUT** /circuits/circuit-types/{id}/ | 
[**circuits_circuits_bulk_destroy**](CircuitsApi.md#circuits_circuits_bulk_destroy) | **DELETE** /circuits/circuits/ | 
[**circuits_circuits_bulk_partial_update**](CircuitsApi.md#circuits_circuits_bulk_partial_update) | **PATCH** /circuits/circuits/ | 
[**circuits_circuits_bulk_update**](CircuitsApi.md#circuits_circuits_bulk_update) | **PUT** /circuits/circuits/ | 
[**circuits_circuits_create**](CircuitsApi.md#circuits_circuits_create) | **POST** /circuits/circuits/ | 
[**circuits_circuits_destroy**](CircuitsApi.md#circuits_circuits_destroy) | **DELETE** /circuits/circuits/{id}/ | 
[**circuits_circuits_list**](CircuitsApi.md#circuits_circuits_list) | **GET** /circuits/circuits/ | 
[**circuits_circuits_notes_create**](CircuitsApi.md#circuits_circuits_notes_create) | **POST** /circuits/circuits/{id}/notes/ | 
[**circuits_circuits_notes_list**](CircuitsApi.md#circuits_circuits_notes_list) | **GET** /circuits/circuits/{id}/notes/ | 
[**circuits_circuits_partial_update**](CircuitsApi.md#circuits_circuits_partial_update) | **PATCH** /circuits/circuits/{id}/ | 
[**circuits_circuits_retrieve**](CircuitsApi.md#circuits_circuits_retrieve) | **GET** /circuits/circuits/{id}/ | 
[**circuits_circuits_update**](CircuitsApi.md#circuits_circuits_update) | **PUT** /circuits/circuits/{id}/ | 
[**circuits_provider_networks_bulk_destroy**](CircuitsApi.md#circuits_provider_networks_bulk_destroy) | **DELETE** /circuits/provider-networks/ | 
[**circuits_provider_networks_bulk_partial_update**](CircuitsApi.md#circuits_provider_networks_bulk_partial_update) | **PATCH** /circuits/provider-networks/ | 
[**circuits_provider_networks_bulk_update**](CircuitsApi.md#circuits_provider_networks_bulk_update) | **PUT** /circuits/provider-networks/ | 
[**circuits_provider_networks_create**](CircuitsApi.md#circuits_provider_networks_create) | **POST** /circuits/provider-networks/ | 
[**circuits_provider_networks_destroy**](CircuitsApi.md#circuits_provider_networks_destroy) | **DELETE** /circuits/provider-networks/{id}/ | 
[**circuits_provider_networks_list**](CircuitsApi.md#circuits_provider_networks_list) | **GET** /circuits/provider-networks/ | 
[**circuits_provider_networks_notes_create**](CircuitsApi.md#circuits_provider_networks_notes_create) | **POST** /circuits/provider-networks/{id}/notes/ | 
[**circuits_provider_networks_notes_list**](CircuitsApi.md#circuits_provider_networks_notes_list) | **GET** /circuits/provider-networks/{id}/notes/ | 
[**circuits_provider_networks_partial_update**](CircuitsApi.md#circuits_provider_networks_partial_update) | **PATCH** /circuits/provider-networks/{id}/ | 
[**circuits_provider_networks_retrieve**](CircuitsApi.md#circuits_provider_networks_retrieve) | **GET** /circuits/provider-networks/{id}/ | 
[**circuits_provider_networks_update**](CircuitsApi.md#circuits_provider_networks_update) | **PUT** /circuits/provider-networks/{id}/ | 
[**circuits_providers_bulk_destroy**](CircuitsApi.md#circuits_providers_bulk_destroy) | **DELETE** /circuits/providers/ | 
[**circuits_providers_bulk_partial_update**](CircuitsApi.md#circuits_providers_bulk_partial_update) | **PATCH** /circuits/providers/ | 
[**circuits_providers_bulk_update**](CircuitsApi.md#circuits_providers_bulk_update) | **PUT** /circuits/providers/ | 
[**circuits_providers_create**](CircuitsApi.md#circuits_providers_create) | **POST** /circuits/providers/ | 
[**circuits_providers_destroy**](CircuitsApi.md#circuits_providers_destroy) | **DELETE** /circuits/providers/{id}/ | 
[**circuits_providers_list**](CircuitsApi.md#circuits_providers_list) | **GET** /circuits/providers/ | 
[**circuits_providers_notes_create**](CircuitsApi.md#circuits_providers_notes_create) | **POST** /circuits/providers/{id}/notes/ | 
[**circuits_providers_notes_list**](CircuitsApi.md#circuits_providers_notes_list) | **GET** /circuits/providers/{id}/notes/ | 
[**circuits_providers_partial_update**](CircuitsApi.md#circuits_providers_partial_update) | **PATCH** /circuits/providers/{id}/ | 
[**circuits_providers_retrieve**](CircuitsApi.md#circuits_providers_retrieve) | **GET** /circuits/providers/{id}/ | 
[**circuits_providers_update**](CircuitsApi.md#circuits_providers_update) | **PUT** /circuits/providers/{id}/ | 



## circuits_circuit_terminations_bulk_destroy

> circuits_circuit_terminations_bulk_destroy(bulk_operation_request, format)


Destroy a list of circuit termination objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuit_terminations_bulk_partial_update

> Vec<crate::models::CircuitTermination> circuits_circuit_terminations_bulk_partial_update(patched_bulk_writable_circuit_termination_request, format)


Partial update a list of circuit termination objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_circuit_termination_request** | [**Vec<crate::models::PatchedBulkWritableCircuitTerminationRequest>**](PatchedBulkWritableCircuitTerminationRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**Vec<crate::models::CircuitTermination>**](CircuitTermination.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuit_terminations_bulk_update

> Vec<crate::models::CircuitTermination> circuits_circuit_terminations_bulk_update(bulk_writable_circuit_termination_request, format)


Update a list of circuit termination objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_circuit_termination_request** | [**Vec<crate::models::BulkWritableCircuitTerminationRequest>**](BulkWritableCircuitTerminationRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**Vec<crate::models::CircuitTermination>**](CircuitTermination.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuit_terminations_create

> crate::models::CircuitTermination circuits_circuit_terminations_create(circuit_termination_request, format)


Create one or more circuit termination objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**circuit_termination_request** | [**CircuitTerminationRequest**](CircuitTerminationRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::CircuitTermination**](CircuitTermination.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuit_terminations_destroy

> circuits_circuit_terminations_destroy(id, format)


Destroy a circuit termination object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this circuit termination. | [required] |
**format** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuit_terminations_list

> crate::models::PaginatedCircuitTerminationList circuits_circuit_terminations_list(cable, cable__isnull, cable__n, circuit, circuit__n, cloud_network, cloud_network__isnull, cloud_network__n, connected, contacts, contacts__isnull, contacts__n, description, description__ic, description__ie, description__iew, description__ire, description__isw, description__n, description__nic, description__nie, description__niew, description__nire, description__nisw, description__nre, description__re, dynamic_groups, dynamic_groups__n, format, has_cable, id, id__n, limit, location, location__isnull, location__n, offset, port_speed, port_speed__gt, port_speed__gte, port_speed__isnull, port_speed__lt, port_speed__lte, port_speed__n, pp_info, pp_info__ic, pp_info__ie, pp_info__iew, pp_info__ire, pp_info__isw, pp_info__n, pp_info__nic, pp_info__nie, pp_info__niew, pp_info__nire, pp_info__nisw, pp_info__nre, pp_info__re, provider_network, provider_network__isnull, provider_network__n, q, sort, tags, tags__isnull, tags__n, teams, teams__isnull, teams__n, term_side, term_side__ic, term_side__ie, term_side__iew, term_side__ire, term_side__isw, term_side__n, term_side__nic, term_side__nie, term_side__niew, term_side__nire, term_side__nisw, term_side__nre, term_side__re, upstream_speed, upstream_speed__gt, upstream_speed__gte, upstream_speed__isnull, upstream_speed__lt, upstream_speed__lte, upstream_speed__n, xconnect_id, xconnect_id__ic, xconnect_id__ie, xconnect_id__iew, xconnect_id__ire, xconnect_id__isw, xconnect_id__n, xconnect_id__nic, xconnect_id__nie, xconnect_id__niew, xconnect_id__nire, xconnect_id__nisw, xconnect_id__nre, xconnect_id__re, depth, exclude_m2m)


Retrieve a list of circuit termination objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**cable** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Cable |  |
**cable__isnull** | Option<**bool**> |  |  |
**cable__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Cable |  |
**circuit** | Option<[**Vec<String>**](String.md)> |  |  |
**circuit__n** | Option<[**Vec<String>**](String.md)> |  |  |
**cloud_network** | Option<[**Vec<String>**](String.md)> |  |  |
**cloud_network__isnull** | Option<**bool**> | Cloud Network (name or ID) is null |  |
**cloud_network__n** | Option<[**Vec<String>**](String.md)> |  |  |
**connected** | Option<**bool**> | Connected status (bool) |  |
**contacts** | Option<[**Vec<String>**](String.md)> |  |  |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null |  |
**contacts__n** | Option<[**Vec<String>**](String.md)> |  |  |
**description** | Option<[**Vec<String>**](String.md)> |  |  |
**description__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**description__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**description__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**description__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**description__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**description__n** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**description__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**description__re** | Option<[**Vec<String>**](String.md)> |  |  |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> |  |  |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> |  |  |
**format** | Option<**String**> |  |  |
**has_cable** | Option<**bool**> | Has cable |  |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. |  |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> |  |  |
**limit** | Option<**i32**> | Number of results to return per page. |  |
**location** | Option<[**Vec<String>**](String.md)> |  |  |
**location__isnull** | Option<**bool**> | Location (name or ID) is null |  |
**location__n** | Option<[**Vec<String>**](String.md)> |  |  |
**offset** | Option<**i32**> | The initial index from which to return the results. |  |
**port_speed** | Option<[**Vec<i32>**](i32.md)> |  |  |
**port_speed__gt** | Option<[**Vec<i32>**](i32.md)> |  |  |
**port_speed__gte** | Option<[**Vec<i32>**](i32.md)> |  |  |
**port_speed__isnull** | Option<**bool**> |  |  |
**port_speed__lt** | Option<[**Vec<i32>**](i32.md)> |  |  |
**port_speed__lte** | Option<[**Vec<i32>**](i32.md)> |  |  |
**port_speed__n** | Option<[**Vec<i32>**](i32.md)> |  |  |
**pp_info** | Option<[**Vec<String>**](String.md)> |  |  |
**pp_info__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**pp_info__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**pp_info__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**pp_info__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**pp_info__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**pp_info__n** | Option<[**Vec<String>**](String.md)> |  |  |
**pp_info__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**pp_info__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**pp_info__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**pp_info__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**pp_info__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**pp_info__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**pp_info__re** | Option<[**Vec<String>**](String.md)> |  |  |
**provider_network** | Option<[**Vec<String>**](String.md)> |  |  |
**provider_network__isnull** | Option<**bool**> | Provider Network (name or ID) is null |  |
**provider_network__n** | Option<[**Vec<String>**](String.md)> |  |  |
**q** | Option<**String**> | Search |  |
**sort** | Option<**String**> | Which field to use when ordering the results. |  |
**tags** | Option<[**Vec<String>**](String.md)> |  |  |
**tags__isnull** | Option<**bool**> |  |  |
**tags__n** | Option<[**Vec<String>**](String.md)> |  |  |
**teams** | Option<[**Vec<String>**](String.md)> |  |  |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null |  |
**teams__n** | Option<[**Vec<String>**](String.md)> |  |  |
**term_side** | Option<[**Vec<String>**](String.md)> |  |  |
**term_side__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**term_side__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**term_side__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**term_side__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**term_side__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**term_side__n** | Option<[**Vec<String>**](String.md)> |  |  |
**term_side__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**term_side__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**term_side__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**term_side__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**term_side__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**term_side__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**term_side__re** | Option<[**Vec<String>**](String.md)> |  |  |
**upstream_speed** | Option<[**Vec<i32>**](i32.md)> |  |  |
**upstream_speed__gt** | Option<[**Vec<i32>**](i32.md)> |  |  |
**upstream_speed__gte** | Option<[**Vec<i32>**](i32.md)> |  |  |
**upstream_speed__isnull** | Option<**bool**> |  |  |
**upstream_speed__lt** | Option<[**Vec<i32>**](i32.md)> |  |  |
**upstream_speed__lte** | Option<[**Vec<i32>**](i32.md)> |  |  |
**upstream_speed__n** | Option<[**Vec<i32>**](i32.md)> |  |  |
**xconnect_id** | Option<[**Vec<String>**](String.md)> |  |  |
**xconnect_id__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**xconnect_id__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**xconnect_id__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**xconnect_id__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**xconnect_id__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**xconnect_id__n** | Option<[**Vec<String>**](String.md)> |  |  |
**xconnect_id__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**xconnect_id__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**xconnect_id__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**xconnect_id__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**xconnect_id__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**xconnect_id__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**xconnect_id__re** | Option<[**Vec<String>**](String.md)> |  |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::PaginatedCircuitTerminationList**](PaginatedCircuitTerminationList.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuit_terminations_notes_create

> crate::models::Note circuits_circuit_terminations_notes_create(id, note_input_request, format)


API methods for returning or creating notes on an object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this circuit termination. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::Note**](Note.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuit_terminations_notes_list

> crate::models::PaginatedNoteList circuits_circuit_terminations_notes_list(id, format, limit, offset, depth, exclude_m2m)


API methods for returning or creating notes on an object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this circuit termination. | [required] |
**format** | Option<**String**> |  |  |
**limit** | Option<**i32**> | Number of results to return per page. |  |
**offset** | Option<**i32**> | The initial index from which to return the results. |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuit_terminations_partial_update

> crate::models::CircuitTermination circuits_circuit_terminations_partial_update(id, format, patched_circuit_termination_request)


Partial update a circuit termination object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this circuit termination. | [required] |
**format** | Option<**String**> |  |  |
**patched_circuit_termination_request** | Option<[**PatchedCircuitTerminationRequest**](PatchedCircuitTerminationRequest.md)> |  |  |

### Return type

[**crate::models::CircuitTermination**](CircuitTermination.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuit_terminations_retrieve

> crate::models::CircuitTermination circuits_circuit_terminations_retrieve(id, format, depth, exclude_m2m)


Retrieve a circuit termination object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this circuit termination. | [required] |
**format** | Option<**String**> |  |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::CircuitTermination**](CircuitTermination.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuit_terminations_trace_retrieve

> crate::models::CircuitTermination circuits_circuit_terminations_trace_retrieve(id, format, depth, exclude_m2m)


Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this circuit termination. | [required] |
**format** | Option<**String**> |  |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::CircuitTermination**](CircuitTermination.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuit_terminations_update

> crate::models::CircuitTermination circuits_circuit_terminations_update(id, circuit_termination_request, format)


Update a circuit termination object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this circuit termination. | [required] |
**circuit_termination_request** | [**CircuitTerminationRequest**](CircuitTerminationRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::CircuitTermination**](CircuitTermination.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuit_types_bulk_destroy

> circuits_circuit_types_bulk_destroy(bulk_operation_request, format)


Destroy a list of circuit type objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuit_types_bulk_partial_update

> Vec<crate::models::CircuitType> circuits_circuit_types_bulk_partial_update(patched_bulk_writable_circuit_type_request, format)


Partial update a list of circuit type objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_circuit_type_request** | [**Vec<crate::models::PatchedBulkWritableCircuitTypeRequest>**](PatchedBulkWritableCircuitTypeRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**Vec<crate::models::CircuitType>**](CircuitType.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuit_types_bulk_update

> Vec<crate::models::CircuitType> circuits_circuit_types_bulk_update(bulk_writable_circuit_type_request, format)


Update a list of circuit type objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_circuit_type_request** | [**Vec<crate::models::BulkWritableCircuitTypeRequest>**](BulkWritableCircuitTypeRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**Vec<crate::models::CircuitType>**](CircuitType.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuit_types_create

> crate::models::CircuitType circuits_circuit_types_create(circuit_type_request, format)


Create one or more circuit type objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**circuit_type_request** | [**CircuitTypeRequest**](CircuitTypeRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::CircuitType**](CircuitType.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuit_types_destroy

> circuits_circuit_types_destroy(id, format)


Destroy a circuit type object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this circuit type. | [required] |
**format** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuit_types_list

> crate::models::PaginatedCircuitTypeList circuits_circuit_types_list(contacts, contacts__isnull, contacts__n, created, created__gt, created__gte, created__isnull, created__lt, created__lte, created__n, description, description__ic, description__ie, description__iew, description__ire, description__isw, description__n, description__nic, description__nie, description__niew, description__nire, description__nisw, description__nre, description__re, dynamic_groups, dynamic_groups__n, format, id, id__n, last_updated, last_updated__gt, last_updated__gte, last_updated__isnull, last_updated__lt, last_updated__lte, last_updated__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, q, sort, teams, teams__isnull, teams__n, depth, exclude_m2m)


Retrieve a list of circuit type objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**contacts** | Option<[**Vec<String>**](String.md)> |  |  |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null |  |
**contacts__n** | Option<[**Vec<String>**](String.md)> |  |  |
**created** | Option<[**Vec<String>**](String.md)> |  |  |
**created__gt** | Option<[**Vec<String>**](String.md)> |  |  |
**created__gte** | Option<[**Vec<String>**](String.md)> |  |  |
**created__isnull** | Option<**bool**> |  |  |
**created__lt** | Option<[**Vec<String>**](String.md)> |  |  |
**created__lte** | Option<[**Vec<String>**](String.md)> |  |  |
**created__n** | Option<[**Vec<String>**](String.md)> |  |  |
**description** | Option<[**Vec<String>**](String.md)> |  |  |
**description__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**description__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**description__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**description__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**description__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**description__n** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**description__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**description__re** | Option<[**Vec<String>**](String.md)> |  |  |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> |  |  |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> |  |  |
**format** | Option<**String**> |  |  |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. |  |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> |  |  |
**last_updated** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__gt** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__gte** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__isnull** | Option<**bool**> |  |  |
**last_updated__lt** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__lte** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__n** | Option<[**Vec<String>**](String.md)> |  |  |
**limit** | Option<**i32**> | Number of results to return per page. |  |
**name** | Option<[**Vec<String>**](String.md)> |  |  |
**name__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**name__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**name__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**name__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**name__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**name__n** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**name__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**name__re** | Option<[**Vec<String>**](String.md)> |  |  |
**offset** | Option<**i32**> | The initial index from which to return the results. |  |
**q** | Option<**String**> | Search |  |
**sort** | Option<**String**> | Which field to use when ordering the results. |  |
**teams** | Option<[**Vec<String>**](String.md)> |  |  |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null |  |
**teams__n** | Option<[**Vec<String>**](String.md)> |  |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::PaginatedCircuitTypeList**](PaginatedCircuitTypeList.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuit_types_notes_create

> crate::models::Note circuits_circuit_types_notes_create(id, note_input_request, format)


API methods for returning or creating notes on an object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this circuit type. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::Note**](Note.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuit_types_notes_list

> crate::models::PaginatedNoteList circuits_circuit_types_notes_list(id, format, limit, offset, depth, exclude_m2m)


API methods for returning or creating notes on an object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this circuit type. | [required] |
**format** | Option<**String**> |  |  |
**limit** | Option<**i32**> | Number of results to return per page. |  |
**offset** | Option<**i32**> | The initial index from which to return the results. |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuit_types_partial_update

> crate::models::CircuitType circuits_circuit_types_partial_update(id, format, patched_circuit_type_request)


Partial update a circuit type object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this circuit type. | [required] |
**format** | Option<**String**> |  |  |
**patched_circuit_type_request** | Option<[**PatchedCircuitTypeRequest**](PatchedCircuitTypeRequest.md)> |  |  |

### Return type

[**crate::models::CircuitType**](CircuitType.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuit_types_retrieve

> crate::models::CircuitType circuits_circuit_types_retrieve(id, format, depth, exclude_m2m)


Retrieve a circuit type object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this circuit type. | [required] |
**format** | Option<**String**> |  |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::CircuitType**](CircuitType.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuit_types_update

> crate::models::CircuitType circuits_circuit_types_update(id, circuit_type_request, format)


Update a circuit type object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this circuit type. | [required] |
**circuit_type_request** | [**CircuitTypeRequest**](CircuitTypeRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::CircuitType**](CircuitType.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuits_bulk_destroy

> circuits_circuits_bulk_destroy(bulk_operation_request, format)


Destroy a list of circuit objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuits_bulk_partial_update

> Vec<crate::models::Circuit> circuits_circuits_bulk_partial_update(patched_bulk_writable_circuit_request, format)


Partial update a list of circuit objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_circuit_request** | [**Vec<crate::models::PatchedBulkWritableCircuitRequest>**](PatchedBulkWritableCircuitRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**Vec<crate::models::Circuit>**](Circuit.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuits_bulk_update

> Vec<crate::models::Circuit> circuits_circuits_bulk_update(bulk_writable_circuit_request, format)


Update a list of circuit objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_circuit_request** | [**Vec<crate::models::BulkWritableCircuitRequest>**](BulkWritableCircuitRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**Vec<crate::models::Circuit>**](Circuit.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuits_create

> crate::models::Circuit circuits_circuits_create(circuit_request, format)


Create one or more circuit objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**circuit_request** | [**CircuitRequest**](CircuitRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::Circuit**](Circuit.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuits_destroy

> circuits_circuits_destroy(id, format)


Destroy a circuit object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this circuit. | [required] |
**format** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuits_list

> crate::models::PaginatedCircuitList circuits_circuits_list(cid, cid__ic, cid__ie, cid__iew, cid__ire, cid__isw, cid__n, cid__nic, cid__nie, cid__niew, cid__nire, cid__nisw, cid__nre, cid__re, circuit_termination_a, circuit_termination_a__isnull, circuit_termination_a__n, circuit_termination_z, circuit_termination_z__isnull, circuit_termination_z__n, circuit_terminations, circuit_terminations__isnull, circuit_terminations__n, circuit_type, circuit_type__n, cloud_network, cloud_network__isnull, cloud_network__n, comments, comments__ic, comments__ie, comments__iew, comments__ire, comments__isw, comments__n, comments__nic, comments__nie, comments__niew, comments__nire, comments__nisw, comments__nre, comments__re, commit_rate, commit_rate__gt, commit_rate__gte, commit_rate__isnull, commit_rate__lt, commit_rate__lte, commit_rate__n, contacts, contacts__isnull, contacts__n, created, created__gt, created__gte, created__isnull, created__lt, created__lte, created__n, description, description__ic, description__ie, description__iew, description__ire, description__isw, description__n, description__nic, description__nie, description__niew, description__nire, description__nisw, description__nre, description__re, dynamic_groups, dynamic_groups__n, format, has_terminations, id, id__n, install_date, install_date__gt, install_date__gte, install_date__isnull, install_date__lt, install_date__lte, install_date__n, last_updated, last_updated__gt, last_updated__gte, last_updated__isnull, last_updated__lt, last_updated__lte, last_updated__n, limit, location, location__isnull, location__n, offset, provider, provider__n, provider_network, provider_network__isnull, provider_network__n, q, sort, status, status__n, tags, tags__isnull, tags__n, teams, teams__isnull, teams__n, tenant, tenant__isnull, tenant__n, tenant_group, tenant_group__isnull, tenant_group__n, tenant_id, tenant_id__isnull, tenant_id__n, depth, exclude_m2m)


Retrieve a list of circuit objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**cid** | Option<[**Vec<String>**](String.md)> |  |  |
**cid__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**cid__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**cid__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**cid__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**cid__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**cid__n** | Option<[**Vec<String>**](String.md)> |  |  |
**cid__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**cid__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**cid__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**cid__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**cid__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**cid__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**cid__re** | Option<[**Vec<String>**](String.md)> |  |  |
**circuit_termination_a** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Termination A (ID) |  |
**circuit_termination_a__isnull** | Option<**bool**> | Termination A (ID) is null |  |
**circuit_termination_a__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Termination A (ID) |  |
**circuit_termination_z** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Termination Z (ID) |  |
**circuit_termination_z__isnull** | Option<**bool**> | Termination Z (ID) is null |  |
**circuit_termination_z__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Termination Z (ID) |  |
**circuit_terminations** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> |  |  |
**circuit_terminations__isnull** | Option<**bool**> |  |  |
**circuit_terminations__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> |  |  |
**circuit_type** | Option<[**Vec<String>**](String.md)> |  |  |
**circuit_type__n** | Option<[**Vec<String>**](String.md)> |  |  |
**cloud_network** | Option<[**Vec<String>**](String.md)> |  |  |
**cloud_network__isnull** | Option<**bool**> | Cloud Network (name or ID) is null |  |
**cloud_network__n** | Option<[**Vec<String>**](String.md)> |  |  |
**comments** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__n** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__re** | Option<[**Vec<String>**](String.md)> |  |  |
**commit_rate** | Option<[**Vec<i32>**](i32.md)> |  |  |
**commit_rate__gt** | Option<[**Vec<i32>**](i32.md)> |  |  |
**commit_rate__gte** | Option<[**Vec<i32>**](i32.md)> |  |  |
**commit_rate__isnull** | Option<**bool**> |  |  |
**commit_rate__lt** | Option<[**Vec<i32>**](i32.md)> |  |  |
**commit_rate__lte** | Option<[**Vec<i32>**](i32.md)> |  |  |
**commit_rate__n** | Option<[**Vec<i32>**](i32.md)> |  |  |
**contacts** | Option<[**Vec<String>**](String.md)> |  |  |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null |  |
**contacts__n** | Option<[**Vec<String>**](String.md)> |  |  |
**created** | Option<[**Vec<String>**](String.md)> |  |  |
**created__gt** | Option<[**Vec<String>**](String.md)> |  |  |
**created__gte** | Option<[**Vec<String>**](String.md)> |  |  |
**created__isnull** | Option<**bool**> |  |  |
**created__lt** | Option<[**Vec<String>**](String.md)> |  |  |
**created__lte** | Option<[**Vec<String>**](String.md)> |  |  |
**created__n** | Option<[**Vec<String>**](String.md)> |  |  |
**description** | Option<[**Vec<String>**](String.md)> |  |  |
**description__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**description__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**description__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**description__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**description__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**description__n** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**description__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**description__re** | Option<[**Vec<String>**](String.md)> |  |  |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> |  |  |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> |  |  |
**format** | Option<**String**> |  |  |
**has_terminations** | Option<**bool**> | Has terminations |  |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. |  |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> |  |  |
**install_date** | Option<[**Vec<String>**](String.md)> |  |  |
**install_date__gt** | Option<[**Vec<String>**](String.md)> |  |  |
**install_date__gte** | Option<[**Vec<String>**](String.md)> |  |  |
**install_date__isnull** | Option<**bool**> |  |  |
**install_date__lt** | Option<[**Vec<String>**](String.md)> |  |  |
**install_date__lte** | Option<[**Vec<String>**](String.md)> |  |  |
**install_date__n** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__gt** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__gte** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__isnull** | Option<**bool**> |  |  |
**last_updated__lt** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__lte** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__n** | Option<[**Vec<String>**](String.md)> |  |  |
**limit** | Option<**i32**> | Number of results to return per page. |  |
**location** | Option<[**Vec<String>**](String.md)> |  |  |
**location__isnull** | Option<**bool**> | Location (name or ID) is null |  |
**location__n** | Option<[**Vec<String>**](String.md)> |  |  |
**offset** | Option<**i32**> | The initial index from which to return the results. |  |
**provider** | Option<[**Vec<String>**](String.md)> |  |  |
**provider__n** | Option<[**Vec<String>**](String.md)> |  |  |
**provider_network** | Option<[**Vec<String>**](String.md)> |  |  |
**provider_network__isnull** | Option<**bool**> | Provider Network (name or ID) is null |  |
**provider_network__n** | Option<[**Vec<String>**](String.md)> |  |  |
**q** | Option<**String**> | Search |  |
**sort** | Option<**String**> | Which field to use when ordering the results. |  |
**status** | Option<[**Vec<String>**](String.md)> |  |  |
**status__n** | Option<[**Vec<String>**](String.md)> |  |  |
**tags** | Option<[**Vec<String>**](String.md)> |  |  |
**tags__isnull** | Option<**bool**> |  |  |
**tags__n** | Option<[**Vec<String>**](String.md)> |  |  |
**teams** | Option<[**Vec<String>**](String.md)> |  |  |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null |  |
**teams__n** | Option<[**Vec<String>**](String.md)> |  |  |
**tenant** | Option<[**Vec<String>**](String.md)> |  |  |
**tenant__isnull** | Option<**bool**> | Tenant (name or ID) is null |  |
**tenant__n** | Option<[**Vec<String>**](String.md)> |  |  |
**tenant_group** | Option<[**Vec<String>**](String.md)> |  |  |
**tenant_group__isnull** | Option<**bool**> | Tenant Group (name or ID) is null |  |
**tenant_group__n** | Option<[**Vec<String>**](String.md)> |  |  |
**tenant_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Tenant (ID) (deprecated, use \"tenant\" filter instead) |  |
**tenant_id__isnull** | Option<**bool**> | Tenant (ID) (deprecated, use \"tenant\" filter instead) is null |  |
**tenant_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Tenant (ID) (deprecated, use \"tenant\" filter instead) |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::PaginatedCircuitList**](PaginatedCircuitList.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuits_notes_create

> crate::models::Note circuits_circuits_notes_create(id, note_input_request, format)


API methods for returning or creating notes on an object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this circuit. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::Note**](Note.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuits_notes_list

> crate::models::PaginatedNoteList circuits_circuits_notes_list(id, format, limit, offset, depth, exclude_m2m)


API methods for returning or creating notes on an object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this circuit. | [required] |
**format** | Option<**String**> |  |  |
**limit** | Option<**i32**> | Number of results to return per page. |  |
**offset** | Option<**i32**> | The initial index from which to return the results. |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuits_partial_update

> crate::models::Circuit circuits_circuits_partial_update(id, format, patched_circuit_request)


Partial update a circuit object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this circuit. | [required] |
**format** | Option<**String**> |  |  |
**patched_circuit_request** | Option<[**PatchedCircuitRequest**](PatchedCircuitRequest.md)> |  |  |

### Return type

[**crate::models::Circuit**](Circuit.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuits_retrieve

> crate::models::Circuit circuits_circuits_retrieve(id, format, depth, exclude_m2m)


Retrieve a circuit object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this circuit. | [required] |
**format** | Option<**String**> |  |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::Circuit**](Circuit.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_circuits_update

> crate::models::Circuit circuits_circuits_update(id, circuit_request, format)


Update a circuit object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this circuit. | [required] |
**circuit_request** | [**CircuitRequest**](CircuitRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::Circuit**](Circuit.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_provider_networks_bulk_destroy

> circuits_provider_networks_bulk_destroy(bulk_operation_request, format)


Destroy a list of provider network objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_provider_networks_bulk_partial_update

> Vec<crate::models::ProviderNetwork> circuits_provider_networks_bulk_partial_update(patched_bulk_writable_provider_network_request, format)


Partial update a list of provider network objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_provider_network_request** | [**Vec<crate::models::PatchedBulkWritableProviderNetworkRequest>**](PatchedBulkWritableProviderNetworkRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**Vec<crate::models::ProviderNetwork>**](ProviderNetwork.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_provider_networks_bulk_update

> Vec<crate::models::ProviderNetwork> circuits_provider_networks_bulk_update(bulk_writable_provider_network_request, format)


Update a list of provider network objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_provider_network_request** | [**Vec<crate::models::BulkWritableProviderNetworkRequest>**](BulkWritableProviderNetworkRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**Vec<crate::models::ProviderNetwork>**](ProviderNetwork.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_provider_networks_create

> crate::models::ProviderNetwork circuits_provider_networks_create(provider_network_request, format)


Create one or more provider network objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**provider_network_request** | [**ProviderNetworkRequest**](ProviderNetworkRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::ProviderNetwork**](ProviderNetwork.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_provider_networks_destroy

> circuits_provider_networks_destroy(id, format)


Destroy a provider network object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this provider network. | [required] |
**format** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_provider_networks_list

> crate::models::PaginatedProviderNetworkList circuits_provider_networks_list(circuit_terminations, circuit_terminations__isnull, circuit_terminations__n, comments, comments__ic, comments__ie, comments__iew, comments__ire, comments__isw, comments__n, comments__nic, comments__nie, comments__niew, comments__nire, comments__nisw, comments__nre, comments__re, contacts, contacts__isnull, contacts__n, created, created__gt, created__gte, created__isnull, created__lt, created__lte, created__n, description, description__ic, description__ie, description__iew, description__ire, description__isw, description__n, description__nic, description__nie, description__niew, description__nire, description__nisw, description__nre, description__re, dynamic_groups, dynamic_groups__n, format, has_circuit_terminations, id, id__n, last_updated, last_updated__gt, last_updated__gte, last_updated__isnull, last_updated__lt, last_updated__lte, last_updated__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, provider, provider__n, q, sort, tags, tags__isnull, tags__n, teams, teams__isnull, teams__n, depth, exclude_m2m)


Retrieve a list of provider network objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**circuit_terminations** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Circuit Terminations (ID) |  |
**circuit_terminations__isnull** | Option<**bool**> | Circuit Terminations (ID) is null |  |
**circuit_terminations__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Circuit Terminations (ID) |  |
**comments** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__n** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__re** | Option<[**Vec<String>**](String.md)> |  |  |
**contacts** | Option<[**Vec<String>**](String.md)> |  |  |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null |  |
**contacts__n** | Option<[**Vec<String>**](String.md)> |  |  |
**created** | Option<[**Vec<String>**](String.md)> |  |  |
**created__gt** | Option<[**Vec<String>**](String.md)> |  |  |
**created__gte** | Option<[**Vec<String>**](String.md)> |  |  |
**created__isnull** | Option<**bool**> |  |  |
**created__lt** | Option<[**Vec<String>**](String.md)> |  |  |
**created__lte** | Option<[**Vec<String>**](String.md)> |  |  |
**created__n** | Option<[**Vec<String>**](String.md)> |  |  |
**description** | Option<[**Vec<String>**](String.md)> |  |  |
**description__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**description__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**description__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**description__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**description__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**description__n** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**description__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**description__re** | Option<[**Vec<String>**](String.md)> |  |  |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> |  |  |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> |  |  |
**format** | Option<**String**> |  |  |
**has_circuit_terminations** | Option<**bool**> | Has circuit terminations |  |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. |  |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> |  |  |
**last_updated** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__gt** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__gte** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__isnull** | Option<**bool**> |  |  |
**last_updated__lt** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__lte** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__n** | Option<[**Vec<String>**](String.md)> |  |  |
**limit** | Option<**i32**> | Number of results to return per page. |  |
**name** | Option<[**Vec<String>**](String.md)> |  |  |
**name__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**name__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**name__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**name__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**name__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**name__n** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**name__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**name__re** | Option<[**Vec<String>**](String.md)> |  |  |
**offset** | Option<**i32**> | The initial index from which to return the results. |  |
**provider** | Option<[**Vec<String>**](String.md)> |  |  |
**provider__n** | Option<[**Vec<String>**](String.md)> |  |  |
**q** | Option<**String**> | Search |  |
**sort** | Option<**String**> | Which field to use when ordering the results. |  |
**tags** | Option<[**Vec<String>**](String.md)> |  |  |
**tags__isnull** | Option<**bool**> |  |  |
**tags__n** | Option<[**Vec<String>**](String.md)> |  |  |
**teams** | Option<[**Vec<String>**](String.md)> |  |  |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null |  |
**teams__n** | Option<[**Vec<String>**](String.md)> |  |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::PaginatedProviderNetworkList**](PaginatedProviderNetworkList.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_provider_networks_notes_create

> crate::models::Note circuits_provider_networks_notes_create(id, note_input_request, format)


API methods for returning or creating notes on an object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this provider network. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::Note**](Note.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_provider_networks_notes_list

> crate::models::PaginatedNoteList circuits_provider_networks_notes_list(id, format, limit, offset, depth, exclude_m2m)


API methods for returning or creating notes on an object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this provider network. | [required] |
**format** | Option<**String**> |  |  |
**limit** | Option<**i32**> | Number of results to return per page. |  |
**offset** | Option<**i32**> | The initial index from which to return the results. |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_provider_networks_partial_update

> crate::models::ProviderNetwork circuits_provider_networks_partial_update(id, format, patched_provider_network_request)


Partial update a provider network object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this provider network. | [required] |
**format** | Option<**String**> |  |  |
**patched_provider_network_request** | Option<[**PatchedProviderNetworkRequest**](PatchedProviderNetworkRequest.md)> |  |  |

### Return type

[**crate::models::ProviderNetwork**](ProviderNetwork.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_provider_networks_retrieve

> crate::models::ProviderNetwork circuits_provider_networks_retrieve(id, format, depth, exclude_m2m)


Retrieve a provider network object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this provider network. | [required] |
**format** | Option<**String**> |  |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::ProviderNetwork**](ProviderNetwork.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_provider_networks_update

> crate::models::ProviderNetwork circuits_provider_networks_update(id, provider_network_request, format)


Update a provider network object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this provider network. | [required] |
**provider_network_request** | [**ProviderNetworkRequest**](ProviderNetworkRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::ProviderNetwork**](ProviderNetwork.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_providers_bulk_destroy

> circuits_providers_bulk_destroy(bulk_operation_request, format)


Destroy a list of provider objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_providers_bulk_partial_update

> Vec<crate::models::Provider> circuits_providers_bulk_partial_update(patched_bulk_writable_provider_request, format)


Partial update a list of provider objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_provider_request** | [**Vec<crate::models::PatchedBulkWritableProviderRequest>**](PatchedBulkWritableProviderRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**Vec<crate::models::Provider>**](Provider.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_providers_bulk_update

> Vec<crate::models::Provider> circuits_providers_bulk_update(bulk_writable_provider_request, format)


Update a list of provider objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_provider_request** | [**Vec<crate::models::BulkWritableProviderRequest>**](BulkWritableProviderRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**Vec<crate::models::Provider>**](Provider.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_providers_create

> crate::models::Provider circuits_providers_create(provider_request, format)


Create one or more provider objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**provider_request** | [**ProviderRequest**](ProviderRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::Provider**](Provider.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_providers_destroy

> circuits_providers_destroy(id, format)


Destroy a provider object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this provider. | [required] |
**format** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_providers_list

> crate::models::PaginatedProviderList circuits_providers_list(account, account__ic, account__ie, account__iew, account__ire, account__isw, account__n, account__nic, account__nie, account__niew, account__nire, account__nisw, account__nre, account__re, admin_contact, admin_contact__ic, admin_contact__ie, admin_contact__iew, admin_contact__ire, admin_contact__isw, admin_contact__n, admin_contact__nic, admin_contact__nie, admin_contact__niew, admin_contact__nire, admin_contact__nisw, admin_contact__nre, admin_contact__re, asn, asn__gt, asn__gte, asn__isnull, asn__lt, asn__lte, asn__n, circuits, circuits__isnull, circuits__n, comments, comments__ic, comments__ie, comments__iew, comments__ire, comments__isw, comments__n, comments__nic, comments__nie, comments__niew, comments__nire, comments__nisw, comments__nre, comments__re, contacts, contacts__isnull, contacts__n, created, created__gt, created__gte, created__isnull, created__lt, created__lte, created__n, dynamic_groups, dynamic_groups__n, format, has_circuits, has_provider_networks, id, id__n, last_updated, last_updated__gt, last_updated__gte, last_updated__isnull, last_updated__lt, last_updated__lte, last_updated__n, limit, location, location__isnull, location__n, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, noc_contact, noc_contact__ic, noc_contact__ie, noc_contact__iew, noc_contact__ire, noc_contact__isw, noc_contact__n, noc_contact__nic, noc_contact__nie, noc_contact__niew, noc_contact__nire, noc_contact__nisw, noc_contact__nre, noc_contact__re, offset, portal_url, portal_url__ic, portal_url__ie, portal_url__iew, portal_url__ire, portal_url__isw, portal_url__n, portal_url__nic, portal_url__nie, portal_url__niew, portal_url__nire, portal_url__nisw, portal_url__nre, portal_url__re, provider_networks, provider_networks__isnull, provider_networks__n, q, sort, tags, tags__isnull, tags__n, teams, teams__isnull, teams__n, depth, exclude_m2m)


Retrieve a list of provider objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**account** | Option<[**Vec<String>**](String.md)> |  |  |
**account__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**account__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**account__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**account__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**account__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**account__n** | Option<[**Vec<String>**](String.md)> |  |  |
**account__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**account__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**account__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**account__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**account__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**account__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**account__re** | Option<[**Vec<String>**](String.md)> |  |  |
**admin_contact** | Option<[**Vec<String>**](String.md)> |  |  |
**admin_contact__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**admin_contact__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**admin_contact__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**admin_contact__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**admin_contact__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**admin_contact__n** | Option<[**Vec<String>**](String.md)> |  |  |
**admin_contact__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**admin_contact__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**admin_contact__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**admin_contact__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**admin_contact__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**admin_contact__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**admin_contact__re** | Option<[**Vec<String>**](String.md)> |  |  |
**asn** | Option<[**Vec<i32>**](i32.md)> |  |  |
**asn__gt** | Option<[**Vec<i32>**](i32.md)> |  |  |
**asn__gte** | Option<[**Vec<i32>**](i32.md)> |  |  |
**asn__isnull** | Option<**bool**> |  |  |
**asn__lt** | Option<[**Vec<i32>**](i32.md)> |  |  |
**asn__lte** | Option<[**Vec<i32>**](i32.md)> |  |  |
**asn__n** | Option<[**Vec<i32>**](i32.md)> |  |  |
**circuits** | Option<[**Vec<String>**](String.md)> |  |  |
**circuits__isnull** | Option<**bool**> | Circuit (ID or circuit ID) is null |  |
**circuits__n** | Option<[**Vec<String>**](String.md)> |  |  |
**comments** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__n** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__re** | Option<[**Vec<String>**](String.md)> |  |  |
**contacts** | Option<[**Vec<String>**](String.md)> |  |  |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null |  |
**contacts__n** | Option<[**Vec<String>**](String.md)> |  |  |
**created** | Option<[**Vec<String>**](String.md)> |  |  |
**created__gt** | Option<[**Vec<String>**](String.md)> |  |  |
**created__gte** | Option<[**Vec<String>**](String.md)> |  |  |
**created__isnull** | Option<**bool**> |  |  |
**created__lt** | Option<[**Vec<String>**](String.md)> |  |  |
**created__lte** | Option<[**Vec<String>**](String.md)> |  |  |
**created__n** | Option<[**Vec<String>**](String.md)> |  |  |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> |  |  |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> |  |  |
**format** | Option<**String**> |  |  |
**has_circuits** | Option<**bool**> | Has circuits |  |
**has_provider_networks** | Option<**bool**> | Has provider networks |  |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. |  |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> |  |  |
**last_updated** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__gt** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__gte** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__isnull** | Option<**bool**> |  |  |
**last_updated__lt** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__lte** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__n** | Option<[**Vec<String>**](String.md)> |  |  |
**limit** | Option<**i32**> | Number of results to return per page. |  |
**location** | Option<[**Vec<String>**](String.md)> |  |  |
**location__isnull** | Option<**bool**> | Location (name or ID) is null |  |
**location__n** | Option<[**Vec<String>**](String.md)> |  |  |
**name** | Option<[**Vec<String>**](String.md)> |  |  |
**name__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**name__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**name__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**name__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**name__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**name__n** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**name__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**name__re** | Option<[**Vec<String>**](String.md)> |  |  |
**noc_contact** | Option<[**Vec<String>**](String.md)> |  |  |
**noc_contact__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**noc_contact__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**noc_contact__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**noc_contact__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**noc_contact__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**noc_contact__n** | Option<[**Vec<String>**](String.md)> |  |  |
**noc_contact__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**noc_contact__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**noc_contact__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**noc_contact__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**noc_contact__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**noc_contact__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**noc_contact__re** | Option<[**Vec<String>**](String.md)> |  |  |
**offset** | Option<**i32**> | The initial index from which to return the results. |  |
**portal_url** | Option<[**Vec<String>**](String.md)> |  |  |
**portal_url__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**portal_url__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**portal_url__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**portal_url__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**portal_url__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**portal_url__n** | Option<[**Vec<String>**](String.md)> |  |  |
**portal_url__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**portal_url__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**portal_url__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**portal_url__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**portal_url__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**portal_url__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**portal_url__re** | Option<[**Vec<String>**](String.md)> |  |  |
**provider_networks** | Option<[**Vec<String>**](String.md)> |  |  |
**provider_networks__isnull** | Option<**bool**> | Provider networks (name or ID) is null |  |
**provider_networks__n** | Option<[**Vec<String>**](String.md)> |  |  |
**q** | Option<**String**> | Search |  |
**sort** | Option<**String**> | Which field to use when ordering the results. |  |
**tags** | Option<[**Vec<String>**](String.md)> |  |  |
**tags__isnull** | Option<**bool**> |  |  |
**tags__n** | Option<[**Vec<String>**](String.md)> |  |  |
**teams** | Option<[**Vec<String>**](String.md)> |  |  |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null |  |
**teams__n** | Option<[**Vec<String>**](String.md)> |  |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::PaginatedProviderList**](PaginatedProviderList.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_providers_notes_create

> crate::models::Note circuits_providers_notes_create(id, note_input_request, format)


API methods for returning or creating notes on an object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this provider. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::Note**](Note.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_providers_notes_list

> crate::models::PaginatedNoteList circuits_providers_notes_list(id, format, limit, offset, depth, exclude_m2m)


API methods for returning or creating notes on an object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this provider. | [required] |
**format** | Option<**String**> |  |  |
**limit** | Option<**i32**> | Number of results to return per page. |  |
**offset** | Option<**i32**> | The initial index from which to return the results. |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_providers_partial_update

> crate::models::Provider circuits_providers_partial_update(id, format, patched_provider_request)


Partial update a provider object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this provider. | [required] |
**format** | Option<**String**> |  |  |
**patched_provider_request** | Option<[**PatchedProviderRequest**](PatchedProviderRequest.md)> |  |  |

### Return type

[**crate::models::Provider**](Provider.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_providers_retrieve

> crate::models::Provider circuits_providers_retrieve(id, format, depth, exclude_m2m)


Retrieve a provider object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this provider. | [required] |
**format** | Option<**String**> |  |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::Provider**](Provider.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## circuits_providers_update

> crate::models::Provider circuits_providers_update(id, provider_request, format)


Update a provider object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this provider. | [required] |
**provider_request** | [**ProviderRequest**](ProviderRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::Provider**](Provider.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)