Skip to content

Latest commit

 

History

History
1703 lines (1059 loc) · 59.8 KB

CircuitsApi.md

File metadata and controls

1703 lines (1059 loc) · 59.8 KB

\CircuitsApi

All URIs are relative to http://localhost:8000/api

Method HTTP request Description
circuits_circuit_terminations_bulk_delete DELETE /circuits/circuit-terminations/
circuits_circuit_terminations_bulk_partial_update PATCH /circuits/circuit-terminations/
circuits_circuit_terminations_bulk_update PUT /circuits/circuit-terminations/
circuits_circuit_terminations_create POST /circuits/circuit-terminations/
circuits_circuit_terminations_delete DELETE /circuits/circuit-terminations/{id}/
circuits_circuit_terminations_list GET /circuits/circuit-terminations/
circuits_circuit_terminations_partial_update PATCH /circuits/circuit-terminations/{id}/
circuits_circuit_terminations_paths GET /circuits/circuit-terminations/{id}/paths/
circuits_circuit_terminations_read GET /circuits/circuit-terminations/{id}/
circuits_circuit_terminations_update PUT /circuits/circuit-terminations/{id}/
circuits_circuit_types_bulk_delete DELETE /circuits/circuit-types/
circuits_circuit_types_bulk_partial_update PATCH /circuits/circuit-types/
circuits_circuit_types_bulk_update PUT /circuits/circuit-types/
circuits_circuit_types_create POST /circuits/circuit-types/
circuits_circuit_types_delete DELETE /circuits/circuit-types/{id}/
circuits_circuit_types_list GET /circuits/circuit-types/
circuits_circuit_types_partial_update PATCH /circuits/circuit-types/{id}/
circuits_circuit_types_read GET /circuits/circuit-types/{id}/
circuits_circuit_types_update PUT /circuits/circuit-types/{id}/
circuits_circuits_bulk_delete DELETE /circuits/circuits/
circuits_circuits_bulk_partial_update PATCH /circuits/circuits/
circuits_circuits_bulk_update PUT /circuits/circuits/
circuits_circuits_create POST /circuits/circuits/
circuits_circuits_delete DELETE /circuits/circuits/{id}/
circuits_circuits_list GET /circuits/circuits/
circuits_circuits_partial_update PATCH /circuits/circuits/{id}/
circuits_circuits_read GET /circuits/circuits/{id}/
circuits_circuits_update PUT /circuits/circuits/{id}/
circuits_provider_networks_bulk_delete DELETE /circuits/provider-networks/
circuits_provider_networks_bulk_partial_update PATCH /circuits/provider-networks/
circuits_provider_networks_bulk_update PUT /circuits/provider-networks/
circuits_provider_networks_create POST /circuits/provider-networks/
circuits_provider_networks_delete DELETE /circuits/provider-networks/{id}/
circuits_provider_networks_list GET /circuits/provider-networks/
circuits_provider_networks_partial_update PATCH /circuits/provider-networks/{id}/
circuits_provider_networks_read GET /circuits/provider-networks/{id}/
circuits_provider_networks_update PUT /circuits/provider-networks/{id}/
circuits_providers_bulk_delete DELETE /circuits/providers/
circuits_providers_bulk_partial_update PATCH /circuits/providers/
circuits_providers_bulk_update PUT /circuits/providers/
circuits_providers_create POST /circuits/providers/
circuits_providers_delete DELETE /circuits/providers/{id}/
circuits_providers_list GET /circuits/providers/
circuits_providers_partial_update PATCH /circuits/providers/{id}/
circuits_providers_read GET /circuits/providers/{id}/
circuits_providers_update PUT /circuits/providers/{id}/

circuits_circuit_terminations_bulk_delete

circuits_circuit_terminations_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuit_terminations_bulk_partial_update

crate::models::CircuitTermination circuits_circuit_terminations_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data WritableCircuitTermination [required]

Return type

crate::models::CircuitTermination

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuit_terminations_bulk_update

crate::models::CircuitTermination circuits_circuit_terminations_bulk_update(data)

Parameters

Name Type Description Required Notes
data WritableCircuitTermination [required]

Return type

crate::models::CircuitTermination

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuit_terminations_create

crate::models::CircuitTermination circuits_circuit_terminations_create(data)

Parameters

Name Type Description Required Notes
data WritableCircuitTermination [required]

Return type

crate::models::CircuitTermination

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuit_terminations_delete

circuits_circuit_terminations_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this circuit termination. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuit_terminations_list

crate::models::CircuitsCircuitTerminationsList200Response circuits_circuit_terminations_list(id, term_side, port_speed, upstream_speed, xconnect_id, description, cable_end, created, last_updated, q, tag, cabled, occupied, circuit_id, site_id, site, provider_network_id, id__n, id__lte, id__lt, id__gte, id__gt, term_side__n, port_speed__n, port_speed__lte, port_speed__lt, port_speed__gte, port_speed__gt, upstream_speed__n, upstream_speed__lte, upstream_speed__lt, upstream_speed__gte, upstream_speed__gt, xconnect_id__n, xconnect_id__ic, xconnect_id__nic, xconnect_id__iew, xconnect_id__niew, xconnect_id__isw, xconnect_id__nisw, xconnect_id__ie, xconnect_id__nie, xconnect_id__empty, description__n, description__ic, description__nic, description__iew, description__niew, description__isw, description__nisw, description__ie, description__nie, description__empty, cable_end__n, created__n, created__lte, created__lt, created__gte, created__gt, last_updated__n, last_updated__lte, last_updated__lt, last_updated__gte, last_updated__gt, tag__n, circuit_id__n, site_id__n, site__n, provider_network_id__n, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
term_side Option<String>
port_speed Option<String>
upstream_speed Option<String>
xconnect_id Option<String>
description Option<String>
cable_end Option<String>
created Option<String>
last_updated Option<String>
q Option<String>
tag Option<String>
cabled Option<String>
occupied Option<String>
circuit_id Option<String>
site_id Option<String>
site Option<String>
provider_network_id Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
term_side__n Option<String>
port_speed__n Option<String>
port_speed__lte Option<String>
port_speed__lt Option<String>
port_speed__gte Option<String>
port_speed__gt Option<String>
upstream_speed__n Option<String>
upstream_speed__lte Option<String>
upstream_speed__lt Option<String>
upstream_speed__gte Option<String>
upstream_speed__gt Option<String>
xconnect_id__n Option<String>
xconnect_id__ic Option<String>
xconnect_id__nic Option<String>
xconnect_id__iew Option<String>
xconnect_id__niew Option<String>
xconnect_id__isw Option<String>
xconnect_id__nisw Option<String>
xconnect_id__ie Option<String>
xconnect_id__nie Option<String>
xconnect_id__empty Option<String>
description__n Option<String>
description__ic Option<String>
description__nic Option<String>
description__iew Option<String>
description__niew Option<String>
description__isw Option<String>
description__nisw Option<String>
description__ie Option<String>
description__nie Option<String>
description__empty Option<String>
cable_end__n Option<String>
created__n Option<String>
created__lte Option<String>
created__lt Option<String>
created__gte Option<String>
created__gt Option<String>
last_updated__n Option<String>
last_updated__lte Option<String>
last_updated__lt Option<String>
last_updated__gte Option<String>
last_updated__gt Option<String>
tag__n Option<String>
circuit_id__n Option<String>
site_id__n Option<String>
site__n Option<String>
provider_network_id__n Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::CircuitsCircuitTerminationsList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuit_terminations_partial_update

crate::models::CircuitTermination circuits_circuit_terminations_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this circuit termination. [required]
data WritableCircuitTermination [required]

Return type

crate::models::CircuitTermination

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuit_terminations_paths

crate::models::CircuitTermination circuits_circuit_terminations_paths(id)

Return all CablePaths which traverse a given pass-through port.

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this circuit termination. [required]

Return type

crate::models::CircuitTermination

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuit_terminations_read

crate::models::CircuitTermination circuits_circuit_terminations_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this circuit termination. [required]

Return type

crate::models::CircuitTermination

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuit_terminations_update

crate::models::CircuitTermination circuits_circuit_terminations_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this circuit termination. [required]
data WritableCircuitTermination [required]

Return type

crate::models::CircuitTermination

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuit_types_bulk_delete

circuits_circuit_types_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuit_types_bulk_partial_update

crate::models::CircuitType circuits_circuit_types_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data CircuitType [required]

Return type

crate::models::CircuitType

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuit_types_bulk_update

crate::models::CircuitType circuits_circuit_types_bulk_update(data)

Parameters

Name Type Description Required Notes
data CircuitType [required]

Return type

crate::models::CircuitType

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuit_types_create

crate::models::CircuitType circuits_circuit_types_create(data)

Parameters

Name Type Description Required Notes
data CircuitType [required]

Return type

crate::models::CircuitType

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuit_types_delete

circuits_circuit_types_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this circuit type. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuit_types_list

crate::models::CircuitsCircuitTypesList200Response circuits_circuit_types_list(id, name, slug, description, created, last_updated, q, tag, id__n, id__lte, id__lt, id__gte, id__gt, name__n, name__ic, name__nic, name__iew, name__niew, name__isw, name__nisw, name__ie, name__nie, name__empty, slug__n, slug__ic, slug__nic, slug__iew, slug__niew, slug__isw, slug__nisw, slug__ie, slug__nie, slug__empty, description__n, description__ic, description__nic, description__iew, description__niew, description__isw, description__nisw, description__ie, description__nie, description__empty, created__n, created__lte, created__lt, created__gte, created__gt, last_updated__n, last_updated__lte, last_updated__lt, last_updated__gte, last_updated__gt, tag__n, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
name Option<String>
slug Option<String>
description Option<String>
created Option<String>
last_updated Option<String>
q Option<String>
tag Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
name__n Option<String>
name__ic Option<String>
name__nic Option<String>
name__iew Option<String>
name__niew Option<String>
name__isw Option<String>
name__nisw Option<String>
name__ie Option<String>
name__nie Option<String>
name__empty Option<String>
slug__n Option<String>
slug__ic Option<String>
slug__nic Option<String>
slug__iew Option<String>
slug__niew Option<String>
slug__isw Option<String>
slug__nisw Option<String>
slug__ie Option<String>
slug__nie Option<String>
slug__empty Option<String>
description__n Option<String>
description__ic Option<String>
description__nic Option<String>
description__iew Option<String>
description__niew Option<String>
description__isw Option<String>
description__nisw Option<String>
description__ie Option<String>
description__nie Option<String>
description__empty Option<String>
created__n Option<String>
created__lte Option<String>
created__lt Option<String>
created__gte Option<String>
created__gt Option<String>
last_updated__n Option<String>
last_updated__lte Option<String>
last_updated__lt Option<String>
last_updated__gte Option<String>
last_updated__gt Option<String>
tag__n Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::CircuitsCircuitTypesList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuit_types_partial_update

crate::models::CircuitType circuits_circuit_types_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this circuit type. [required]
data CircuitType [required]

Return type

crate::models::CircuitType

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuit_types_read

crate::models::CircuitType circuits_circuit_types_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this circuit type. [required]

Return type

crate::models::CircuitType

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuit_types_update

crate::models::CircuitType circuits_circuit_types_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this circuit type. [required]
data CircuitType [required]

Return type

crate::models::CircuitType

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuits_bulk_delete

circuits_circuits_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuits_bulk_partial_update

crate::models::Circuit circuits_circuits_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data WritableCircuit [required]

Return type

crate::models::Circuit

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuits_bulk_update

crate::models::Circuit circuits_circuits_bulk_update(data)

Parameters

Name Type Description Required Notes
data WritableCircuit [required]

Return type

crate::models::Circuit

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuits_create

crate::models::Circuit circuits_circuits_create(data)

Parameters

Name Type Description Required Notes
data WritableCircuit [required]

Return type

crate::models::Circuit

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuits_delete

circuits_circuits_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this circuit. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuits_list

crate::models::CircuitsCircuitsList200Response circuits_circuits_list(id, cid, description, install_date, termination_date, commit_rate, created, last_updated, q, tag, tenant_group_id, tenant_group, tenant_id, tenant, contact, contact_role, contact_group, provider_id, provider, provider_network_id, type_id, r#type, status, region_id, region, site_group_id, site_group, site_id, site, id__n, id__lte, id__lt, id__gte, id__gt, cid__n, cid__ic, cid__nic, cid__iew, cid__niew, cid__isw, cid__nisw, cid__ie, cid__nie, cid__empty, description__n, description__ic, description__nic, description__iew, description__niew, description__isw, description__nisw, description__ie, description__nie, description__empty, install_date__n, install_date__lte, install_date__lt, install_date__gte, install_date__gt, termination_date__n, termination_date__lte, termination_date__lt, termination_date__gte, termination_date__gt, commit_rate__n, commit_rate__lte, commit_rate__lt, commit_rate__gte, commit_rate__gt, created__n, created__lte, created__lt, created__gte, created__gt, last_updated__n, last_updated__lte, last_updated__lt, last_updated__gte, last_updated__gt, tag__n, tenant_group_id__n, tenant_group__n, tenant_id__n, tenant__n, contact__n, contact_role__n, contact_group__n, provider_id__n, provider__n, provider_network_id__n, type_id__n, type__n, status__n, region_id__n, region__n, site_group_id__n, site_group__n, site_id__n, site__n, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
cid Option<String>
description Option<String>
install_date Option<String>
termination_date Option<String>
commit_rate Option<String>
created Option<String>
last_updated Option<String>
q Option<String>
tag Option<String>
tenant_group_id Option<String>
tenant_group Option<String>
tenant_id Option<String>
tenant Option<String>
contact Option<String>
contact_role Option<String>
contact_group Option<String>
provider_id Option<String>
provider Option<String>
provider_network_id Option<String>
type_id Option<String>
r#type Option<String>
status Option<String>
region_id Option<String>
region Option<String>
site_group_id Option<String>
site_group Option<String>
site_id Option<String>
site Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
cid__n Option<String>
cid__ic Option<String>
cid__nic Option<String>
cid__iew Option<String>
cid__niew Option<String>
cid__isw Option<String>
cid__nisw Option<String>
cid__ie Option<String>
cid__nie Option<String>
cid__empty Option<String>
description__n Option<String>
description__ic Option<String>
description__nic Option<String>
description__iew Option<String>
description__niew Option<String>
description__isw Option<String>
description__nisw Option<String>
description__ie Option<String>
description__nie Option<String>
description__empty Option<String>
install_date__n Option<String>
install_date__lte Option<String>
install_date__lt Option<String>
install_date__gte Option<String>
install_date__gt Option<String>
termination_date__n Option<String>
termination_date__lte Option<String>
termination_date__lt Option<String>
termination_date__gte Option<String>
termination_date__gt Option<String>
commit_rate__n Option<String>
commit_rate__lte Option<String>
commit_rate__lt Option<String>
commit_rate__gte Option<String>
commit_rate__gt Option<String>
created__n Option<String>
created__lte Option<String>
created__lt Option<String>
created__gte Option<String>
created__gt Option<String>
last_updated__n Option<String>
last_updated__lte Option<String>
last_updated__lt Option<String>
last_updated__gte Option<String>
last_updated__gt Option<String>
tag__n Option<String>
tenant_group_id__n Option<String>
tenant_group__n Option<String>
tenant_id__n Option<String>
tenant__n Option<String>
contact__n Option<String>
contact_role__n Option<String>
contact_group__n Option<String>
provider_id__n Option<String>
provider__n Option<String>
provider_network_id__n Option<String>
type_id__n Option<String>
type__n Option<String>
status__n Option<String>
region_id__n Option<String>
region__n Option<String>
site_group_id__n Option<String>
site_group__n Option<String>
site_id__n Option<String>
site__n Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::CircuitsCircuitsList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuits_partial_update

crate::models::Circuit circuits_circuits_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this circuit. [required]
data WritableCircuit [required]

Return type

crate::models::Circuit

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuits_read

crate::models::Circuit circuits_circuits_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this circuit. [required]

Return type

crate::models::Circuit

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_circuits_update

crate::models::Circuit circuits_circuits_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this circuit. [required]
data WritableCircuit [required]

Return type

crate::models::Circuit

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_provider_networks_bulk_delete

circuits_provider_networks_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_provider_networks_bulk_partial_update

crate::models::ProviderNetwork circuits_provider_networks_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data WritableProviderNetwork [required]

Return type

crate::models::ProviderNetwork

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_provider_networks_bulk_update

crate::models::ProviderNetwork circuits_provider_networks_bulk_update(data)

Parameters

Name Type Description Required Notes
data WritableProviderNetwork [required]

Return type

crate::models::ProviderNetwork

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_provider_networks_create

crate::models::ProviderNetwork circuits_provider_networks_create(data)

Parameters

Name Type Description Required Notes
data WritableProviderNetwork [required]

Return type

crate::models::ProviderNetwork

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_provider_networks_delete

circuits_provider_networks_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this provider network. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_provider_networks_list

crate::models::CircuitsProviderNetworksList200Response circuits_provider_networks_list(id, name, service_id, description, created, last_updated, q, tag, provider_id, provider, id__n, id__lte, id__lt, id__gte, id__gt, name__n, name__ic, name__nic, name__iew, name__niew, name__isw, name__nisw, name__ie, name__nie, name__empty, service_id__n, service_id__ic, service_id__nic, service_id__iew, service_id__niew, service_id__isw, service_id__nisw, service_id__ie, service_id__nie, service_id__empty, description__n, description__ic, description__nic, description__iew, description__niew, description__isw, description__nisw, description__ie, description__nie, description__empty, created__n, created__lte, created__lt, created__gte, created__gt, last_updated__n, last_updated__lte, last_updated__lt, last_updated__gte, last_updated__gt, tag__n, provider_id__n, provider__n, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
name Option<String>
service_id Option<String>
description Option<String>
created Option<String>
last_updated Option<String>
q Option<String>
tag Option<String>
provider_id Option<String>
provider Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
name__n Option<String>
name__ic Option<String>
name__nic Option<String>
name__iew Option<String>
name__niew Option<String>
name__isw Option<String>
name__nisw Option<String>
name__ie Option<String>
name__nie Option<String>
name__empty Option<String>
service_id__n Option<String>
service_id__ic Option<String>
service_id__nic Option<String>
service_id__iew Option<String>
service_id__niew Option<String>
service_id__isw Option<String>
service_id__nisw Option<String>
service_id__ie Option<String>
service_id__nie Option<String>
service_id__empty Option<String>
description__n Option<String>
description__ic Option<String>
description__nic Option<String>
description__iew Option<String>
description__niew Option<String>
description__isw Option<String>
description__nisw Option<String>
description__ie Option<String>
description__nie Option<String>
description__empty Option<String>
created__n Option<String>
created__lte Option<String>
created__lt Option<String>
created__gte Option<String>
created__gt Option<String>
last_updated__n Option<String>
last_updated__lte Option<String>
last_updated__lt Option<String>
last_updated__gte Option<String>
last_updated__gt Option<String>
tag__n Option<String>
provider_id__n Option<String>
provider__n Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::CircuitsProviderNetworksList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_provider_networks_partial_update

crate::models::ProviderNetwork circuits_provider_networks_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this provider network. [required]
data WritableProviderNetwork [required]

Return type

crate::models::ProviderNetwork

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_provider_networks_read

crate::models::ProviderNetwork circuits_provider_networks_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this provider network. [required]

Return type

crate::models::ProviderNetwork

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_provider_networks_update

crate::models::ProviderNetwork circuits_provider_networks_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this provider network. [required]
data WritableProviderNetwork [required]

Return type

crate::models::ProviderNetwork

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_providers_bulk_delete

circuits_providers_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_providers_bulk_partial_update

crate::models::Provider circuits_providers_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data WritableProvider [required]

Return type

crate::models::Provider

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_providers_bulk_update

crate::models::Provider circuits_providers_bulk_update(data)

Parameters

Name Type Description Required Notes
data WritableProvider [required]

Return type

crate::models::Provider

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_providers_create

crate::models::Provider circuits_providers_create(data)

Parameters

Name Type Description Required Notes
data WritableProvider [required]

Return type

crate::models::Provider

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_providers_delete

circuits_providers_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this provider. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_providers_list

crate::models::CircuitsProvidersList200Response circuits_providers_list(id, name, slug, account, created, last_updated, q, tag, contact, contact_role, contact_group, region_id, region, site_group_id, site_group, site_id, site, asn_id, id__n, id__lte, id__lt, id__gte, id__gt, name__n, name__ic, name__nic, name__iew, name__niew, name__isw, name__nisw, name__ie, name__nie, name__empty, slug__n, slug__ic, slug__nic, slug__iew, slug__niew, slug__isw, slug__nisw, slug__ie, slug__nie, slug__empty, account__n, account__ic, account__nic, account__iew, account__niew, account__isw, account__nisw, account__ie, account__nie, account__empty, created__n, created__lte, created__lt, created__gte, created__gt, last_updated__n, last_updated__lte, last_updated__lt, last_updated__gte, last_updated__gt, tag__n, contact__n, contact_role__n, contact_group__n, region_id__n, region__n, site_group_id__n, site_group__n, site_id__n, site__n, asn_id__n, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
name Option<String>
slug Option<String>
account Option<String>
created Option<String>
last_updated Option<String>
q Option<String>
tag Option<String>
contact Option<String>
contact_role Option<String>
contact_group Option<String>
region_id Option<String>
region Option<String>
site_group_id Option<String>
site_group Option<String>
site_id Option<String>
site Option<String>
asn_id Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
name__n Option<String>
name__ic Option<String>
name__nic Option<String>
name__iew Option<String>
name__niew Option<String>
name__isw Option<String>
name__nisw Option<String>
name__ie Option<String>
name__nie Option<String>
name__empty Option<String>
slug__n Option<String>
slug__ic Option<String>
slug__nic Option<String>
slug__iew Option<String>
slug__niew Option<String>
slug__isw Option<String>
slug__nisw Option<String>
slug__ie Option<String>
slug__nie Option<String>
slug__empty Option<String>
account__n Option<String>
account__ic Option<String>
account__nic Option<String>
account__iew Option<String>
account__niew Option<String>
account__isw Option<String>
account__nisw Option<String>
account__ie Option<String>
account__nie Option<String>
account__empty Option<String>
created__n Option<String>
created__lte Option<String>
created__lt Option<String>
created__gte Option<String>
created__gt Option<String>
last_updated__n Option<String>
last_updated__lte Option<String>
last_updated__lt Option<String>
last_updated__gte Option<String>
last_updated__gt Option<String>
tag__n Option<String>
contact__n Option<String>
contact_role__n Option<String>
contact_group__n Option<String>
region_id__n Option<String>
region__n Option<String>
site_group_id__n Option<String>
site_group__n Option<String>
site_id__n Option<String>
site__n Option<String>
asn_id__n Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::CircuitsProvidersList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_providers_partial_update

crate::models::Provider circuits_providers_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this provider. [required]
data WritableProvider [required]

Return type

crate::models::Provider

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_providers_read

crate::models::Provider circuits_providers_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this provider. [required]

Return type

crate::models::Provider

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

circuits_providers_update

crate::models::Provider circuits_providers_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this provider. [required]
data WritableProvider [required]

Return type

crate::models::Provider

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]