GET /circuits/circuits/

netbox.dev

Summary:
Operation ID: circuits_circuits_list
Auth: unknown

Parameters (102)

cid (string, query, optional)
cid__empty (string, query, optional)
cid__ic (string, query, optional)
cid__ie (string, query, optional)
cid__iew (string, query, optional)
cid__isw (string, query, optional)
cid__n (string, query, optional)
cid__nic (string, query, optional)
cid__nie (string, query, optional)
cid__niew (string, query, optional)
cid__nisw (string, query, optional)
commit_rate (string, query, optional)
commit_rate__gt (string, query, optional)
commit_rate__gte (string, query, optional)
commit_rate__lt (string, query, optional)
commit_rate__lte (string, query, optional)
commit_rate__n (string, query, optional)
contact (string, query, optional)
contact__n (string, query, optional)
contact_group (string, query, optional)
contact_group__n (string, query, optional)
contact_role (string, query, optional)
contact_role__n (string, query, optional)
created (string, query, optional)
created__gt (string, query, optional)
created__gte (string, query, optional)
created__lt (string, query, optional)
created__lte (string, query, optional)
created__n (string, query, optional)
description (string, query, optional)
description__empty (string, query, optional)
description__ic (string, query, optional)
description__ie (string, query, optional)
description__iew (string, query, optional)
description__isw (string, query, optional)
description__n (string, query, optional)
description__nic (string, query, optional)
description__nie (string, query, optional)
description__niew (string, query, optional)
description__nisw (string, query, optional)
id (string, query, optional)
id__gt (string, query, optional)
id__gte (string, query, optional)
id__lt (string, query, optional)
id__lte (string, query, optional)
id__n (string, query, optional)
install_date (string, query, optional)
install_date__gt (string, query, optional)
install_date__gte (string, query, optional)
install_date__lt (string, query, optional)
install_date__lte (string, query, optional)
install_date__n (string, query, optional)
last_updated (string, query, optional)
last_updated__gt (string, query, optional)
last_updated__gte (string, query, optional)
last_updated__lt (string, query, optional)
last_updated__lte (string, query, optional)
last_updated__n (string, query, optional)
limit (integer, query, optional)

Number of results to return per page.

offset (integer, query, optional)

The initial index from which to return the results.

ordering (string, query, optional)

Which field to use when ordering the results.

provider (string, query, optional)
provider__n (string, query, optional)
provider_id (string, query, optional)
provider_id__n (string, query, optional)
provider_network_id (string, query, optional)
provider_network_id__n (string, query, optional)
q (string, query, optional)
region (string, query, optional)
region__n (string, query, optional)
region_id (string, query, optional)
region_id__n (string, query, optional)
site (string, query, optional)
site__n (string, query, optional)
site_group (string, query, optional)
site_group__n (string, query, optional)
site_group_id (string, query, optional)
site_group_id__n (string, query, optional)
site_id (string, query, optional)
site_id__n (string, query, optional)
status (string, query, optional)
status__n (string, query, optional)
tag (string, query, optional)
tag__n (string, query, optional)
tenant (string, query, optional)
tenant__n (string, query, optional)
tenant_group (string, query, optional)
tenant_group__n (string, query, optional)
tenant_group_id (string, query, optional)
tenant_group_id__n (string, query, optional)
tenant_id (string, query, optional)
tenant_id__n (string, query, optional)
termination_date (string, query, optional)
termination_date__gt (string, query, optional)
termination_date__gte (string, query, optional)
termination_date__lt (string, query, optional)
termination_date__lte (string, query, optional)
termination_date__n (string, query, optional)
type (string, query, optional)
type__n (string, query, optional)
type_id (string, query, optional)
type_id__n (string, query, optional)

No probe data for this endpoint yet.