action netbox_circuits_circuits_read { label: "circuits_circuits_read" description: "" provider: netbox method: GET path: "/circuits/circuits/{id}/" encoding: json output: { type: "object" required: ["cid", "provider", "type"] properties: { cid: { type: "string" } comments: { type: "string" } commit_rate: { type: "integer" } created: { type: "string" format: "date-time" } custom_fields: { type: "object" } description: { type: "string" } display: { type: "string" } id: { type: "integer" } install_date: { type: "string" format: "date" } last_updated: { type: "string" format: "date-time" } provider: { type: "object" required: ["name", "slug"] properties: { circuit_count: { type: "integer" } display: { type: "string" } id: { type: "integer" } name: { type: "string" } slug: { type: "string" format: "slug" } url: { type: "string" format: "uri" } } } status: { type: "object" required: ["label", "value"] properties: { label: { type: "string" enum: ["Planned", "Provisioning", "Active", "Offline", "Deprovisioning", "Decommissioned"] } value: { type: "string" enum: ["planned", "provisioning", "active", "offline", "deprovisioning", "decommissioned"] } } } tags: { type: "array" items: { type: "object" required: ["name", "slug"] properties: { color: { type: "string" } display: { type: "string" } id: { type: "integer" } name: { type: "string" } slug: { type: "string" format: "slug" } url: { type: "string" format: "uri" } } } } tenant: { type: "object" required: ["name", "slug"] properties: { display: { type: "string" } id: { type: "integer" } name: { type: "string" } slug: { type: "string" format: "slug" } url: { type: "string" format: "uri" } } } termination_a: { type: "object" required: ["provider_network", "site"] properties: { description: { type: "string" } display: { type: "string" } id: { type: "integer" } port_speed: { type: "integer" } provider_network: { type: "object" required: ["name"] properties: { display: { type: "string" } id: { type: "integer" } name: { type: "string" } url: { type: "string" format: "uri" } } } site: { type: "object" required: ["name", "slug"] properties: { display: { type: "string" } id: { type: "integer" } name: { type: "string" } slug: { type: "string" format: "slug" } url: { type: "string" format: "uri" } } } upstream_speed: { type: "integer" description: "Upstream speed, if different from port speed" } url: { type: "string" format: "uri" } xconnect_id: { type: "string" } } } termination_date: { type: "string" format: "date" } termination_z: { type: "object" additionalProperties: true } type: { type: "object" required: ["name", "slug"] properties: { circuit_count: { type: "integer" } display: { type: "string" } id: { type: "integer" } name: { type: "string" } slug: { type: "string" format: "slug" } url: { type: "string" format: "uri" } } } url: { type: "string" format: "uri" } } } }