This endpoint is designed to be accessed from an unauthenticated API client. It generates and records a device_code and user_code which must be verified and confirmed prior to a token being granted.

\n","device_auth_confirm",{"_15":24,"_17":59,"_19":60,"_21":61},"/device/confirm","Confirm an OAuth 2.0 Device Authorization Grant","

This endpoint is designed to be accessed by the user agent (browser), not the client requesting the token. So we do not actually return the token here; it will be returned in response to the poll on /device/token.

\n","device_access_token",{"_15":24,"_17":64,"_19":65,"_21":66},"/device/token","Request a device access token","

This endpoint should be polled by the client until the user code is verified and the grant is confirmed.

\n","logout",{"_15":24,"_17":69,"_19":70,"_21":-7},"/v1/logout","Log user out of web console by deleting session on client and server","current_user_view",{"_15":16,"_17":73,"_19":74,"_21":-7},"/v1/me","Fetch user for current session","current_user_groups",{"_15":16,"_17":77,"_19":78,"_21":-7},"/v1/me/groups","Fetch current user's groups","current_user_ssh_key_list",{"_15":16,"_17":81,"_19":82,"_21":83},"/v1/me/ssh-keys","List SSH public keys","

Lists SSH public keys for the currently authenticated user.

\n","current_user_ssh_key_create",{"_15":24,"_17":81,"_19":86,"_21":87},"Create SSH public key","

Create an SSH public key for the currently authenticated user.

\n","current_user_ssh_key_view",{"_15":16,"_17":90,"_19":91,"_21":92},"/v1/me/ssh-keys/{ssh_key}","Fetch SSH public key","

Fetch SSH public key associated with the currently authenticated user.

\n","current_user_ssh_key_delete",{"_15":36,"_17":90,"_19":95,"_21":96},"Delete SSH public key","

Delete an SSH public key associated with the currently authenticated user.

\n","disk_list",{"_15":16,"_17":99,"_19":100,"_21":-7},"/v1/disks","List disks","disk_create",{"_15":24,"_17":99,"_19":103,"_21":-7},"Create a disk","disk_view",{"_15":16,"_17":106,"_19":107,"_21":-7},"/v1/disks/{disk}","Fetch disk","disk_delete",{"_15":36,"_17":106,"_19":110,"_21":-7},"Delete disk","disk_bulk_write_import",{"_15":24,"_17":113,"_19":114,"_21":-7},"/v1/disks/{disk}/bulk-write","Import blocks into disk","disk_bulk_write_import_start",{"_15":24,"_17":117,"_19":118,"_21":119},"/v1/disks/{disk}/bulk-write-start","Start importing blocks into disk","

Start the process of importing blocks into a disk

\n","disk_bulk_write_import_stop",{"_15":24,"_17":122,"_19":123,"_21":124},"/v1/disks/{disk}/bulk-write-stop","Stop importing blocks into disk","

Stop the process of importing blocks into a disk

\n","disk_finalize_import",{"_15":24,"_17":127,"_19":128,"_21":-7},"/v1/disks/{disk}/finalize","Confirm disk block import completion","disk_metrics_list",{"_15":16,"_17":131,"_19":132,"_21":-7},"/v1/disks/{disk}/metrics/{metric}","Fetch disk metrics","probe_list",{"_15":16,"_17":135,"_19":136,"_21":-7},"/experimental/v1/probes","List instrumentation probes","probe_create",{"_15":24,"_17":135,"_19":139,"_21":-7},"Create instrumentation probe","probe_view",{"_15":16,"_17":142,"_19":143,"_21":-7},"/experimental/v1/probes/{probe}","View instrumentation probe","probe_delete",{"_15":36,"_17":142,"_19":146,"_21":-7},"Delete instrumentation probe","support_bundle_list",{"_15":16,"_17":149,"_19":150,"_21":-7},"/experimental/v1/system/support-bundles","List all support bundles","support_bundle_create",{"_15":24,"_17":149,"_19":153,"_21":-7},"Create a new support bundle","support_bundle_view",{"_15":16,"_17":156,"_19":157,"_21":-7},"/experimental/v1/system/support-bundles/{bundle_id}","View a support bundle","support_bundle_delete",{"_15":36,"_17":156,"_19":160,"_21":161},"Delete an existing support bundle","

May also be used to cancel a support bundle which is currently being collected, or to remove metadata for a support bundle that has failed.

\n","support_bundle_download",{"_15":16,"_17":164,"_19":165,"_21":-7},"/experimental/v1/system/support-bundles/{bundle_id}/download","Download the contents of a support bundle","support_bundle_head",{"_15":168,"_17":164,"_19":169,"_21":-7},"head","Download the metadata of a support bundle","support_bundle_download_file",{"_15":16,"_17":172,"_19":173,"_21":-7},"/experimental/v1/system/support-bundles/{bundle_id}/download/{file}","Download a file within a support bundle","support_bundle_head_file",{"_15":168,"_17":172,"_19":176,"_21":-7},"Download the metadata of a file within the support bundle","support_bundle_index",{"_15":16,"_17":179,"_19":180,"_21":-7},"/experimental/v1/system/support-bundles/{bundle_id}/index","Download the index of a support bundle","affinity_group_list",{"_15":16,"_17":183,"_19":184,"_21":-7},"/v1/affinity-groups","List affinity groups","affinity_group_create",{"_15":24,"_17":183,"_19":187,"_21":-7},"Create affinity group","affinity_group_view",{"_15":16,"_17":190,"_19":191,"_21":-7},"/v1/affinity-groups/{affinity_group}","Fetch affinity group","affinity_group_update",{"_15":32,"_17":190,"_19":194,"_21":-7},"Update affinity group","affinity_group_delete",{"_15":36,"_17":190,"_19":197,"_21":-7},"Delete affinity group","affinity_group_member_list",{"_15":16,"_17":200,"_19":201,"_21":-7},"/v1/affinity-groups/{affinity_group}/members","List affinity group members","affinity_group_member_instance_view",{"_15":16,"_17":204,"_19":205,"_21":-7},"/v1/affinity-groups/{affinity_group}/members/instance/{instance}","Fetch affinity group member","affinity_group_member_instance_add",{"_15":24,"_17":204,"_19":208,"_21":-7},"Add member to affinity group","affinity_group_member_instance_delete",{"_15":36,"_17":204,"_19":211,"_21":-7},"Remove member from affinity group","instance_affinity_group_list",{"_15":16,"_17":214,"_19":215,"_21":-7},"/v1/instances/{instance}/affinity-groups","List affinity groups containing instance","system_update_put_repository",{"_15":32,"_17":218,"_19":219,"_21":-7},"/v1/system/update/repository","Upload TUF repository","system_update_get_repository",{"_15":16,"_17":222,"_19":223,"_21":224},"/v1/system/update/repository/{system_version}","Fetch TUF repository description","

Fetch description of TUF repository by system version.

\n","target_release_view",{"_15":16,"_17":227,"_19":228,"_21":229},"/v1/system/update/target-release","Get the current target release of the rack's system software","

This may not correspond to the actual software running on the rack at the time of request; it is instead the release that the rack reconfigurator should be moving towards as a goal state. After some number of planning and execution phases, the software running on the rack should eventually correspond to the release described here.

\n","target_release_update",{"_15":32,"_17":227,"_19":232,"_21":233},"Set the current target release of the rack's system software","

The rack reconfigurator will treat the software specified here as a goal state for the rack's software, and attempt to asynchronously update to that release.

\n","timeseries_query",{"_15":24,"_17":236,"_19":237,"_21":238},"/v1/timeseries/query","Run project-scoped timeseries query","

Queries are written in OxQL. Project must be specified by name or ID in URL query parameter. The OxQL query will only return timeseries data from the specified project.

\n","floating_ip_list",{"_15":16,"_17":241,"_19":242,"_21":-7},"/v1/floating-ips","List floating IPs","floating_ip_create",{"_15":24,"_17":241,"_19":245,"_21":-7},"Create floating IP","floating_ip_view",{"_15":16,"_17":248,"_19":249,"_21":-7},"/v1/floating-ips/{floating_ip}","Fetch floating IP","floating_ip_update",{"_15":32,"_17":248,"_19":252,"_21":-7},"Update floating IP","floating_ip_delete",{"_15":36,"_17":248,"_19":255,"_21":-7},"Delete floating IP","floating_ip_attach",{"_15":24,"_17":258,"_19":259,"_21":260},"/v1/floating-ips/{floating_ip}/attach","Attach floating IP","

Attach floating IP to an instance or other resource.

\n","floating_ip_detach",{"_15":24,"_17":263,"_19":264,"_21":-7},"/v1/floating-ips/{floating_ip}/detach","Detach floating IP","image_list",{"_15":16,"_17":267,"_19":268,"_21":269},"/v1/images","List images","

List images which are global or scoped to the specified project. The images are returned sorted by creation date, with the most recent images appearing first.

\n","image_create",{"_15":24,"_17":267,"_19":272,"_21":273},"Create image","

Create a new image in a project.

\n","image_view",{"_15":16,"_17":276,"_19":277,"_21":278},"/v1/images/{image}","Fetch image","

Fetch the details for a specific image in a project.

\n","image_delete",{"_15":36,"_17":276,"_19":281,"_21":282},"Delete image","

Permanently delete an image from a project. This operation cannot be undone. Any instances in the project using the image will continue to run, however new instances can not be created with this image.

\n","image_demote",{"_15":24,"_17":285,"_19":286,"_21":287},"/v1/images/{image}/demote","Demote silo image","

Demote silo image to be visible only to a specified project

\n","image_promote",{"_15":24,"_17":290,"_19":291,"_21":292},"/v1/images/{image}/promote","Promote project image","

Promote project image to be visible to all projects in the silo

\n","instance_list",{"_15":16,"_17":295,"_19":296,"_21":-7},"/v1/instances","List instances","instance_create",{"_15":24,"_17":295,"_19":299,"_21":-7},"Create instance","instance_view",{"_15":16,"_17":302,"_19":303,"_21":-7},"/v1/instances/{instance}","Fetch instance","instance_update",{"_15":32,"_17":302,"_19":306,"_21":-7},"Update instance","instance_delete",{"_15":36,"_17":302,"_19":309,"_21":-7},"Delete instance","instance_anti_affinity_group_list",{"_15":16,"_17":312,"_19":313,"_21":-7},"/v1/instances/{instance}/anti-affinity-groups","List anti-affinity groups containing instance","instance_disk_list",{"_15":16,"_17":316,"_19":317,"_21":-7},"/v1/instances/{instance}/disks","List disks for instance","instance_disk_attach",{"_15":24,"_17":320,"_19":321,"_21":-7},"/v1/instances/{instance}/disks/attach","Attach disk to instance","instance_disk_detach",{"_15":24,"_17":324,"_19":325,"_21":-7},"/v1/instances/{instance}/disks/detach","Detach disk from instance","instance_external_ip_list",{"_15":16,"_17":328,"_19":329,"_21":-7},"/v1/instances/{instance}/external-ips","List external IP addresses","instance_ephemeral_ip_attach",{"_15":24,"_17":332,"_19":333,"_21":-7},"/v1/instances/{instance}/external-ips/ephemeral","Allocate and attach ephemeral IP to instance","instance_ephemeral_ip_detach",{"_15":36,"_17":332,"_19":336,"_21":-7},"Detach and deallocate ephemeral IP from instance","instance_reboot",{"_15":24,"_17":339,"_19":340,"_21":-7},"/v1/instances/{instance}/reboot","Reboot an instance","instance_serial_console",{"_15":16,"_17":343,"_19":344,"_21":-7},"/v1/instances/{instance}/serial-console","Fetch instance serial console","instance_serial_console_stream",{"_15":16,"_17":347,"_19":348,"_21":-7},"/v1/instances/{instance}/serial-console/stream","Stream instance serial console","instance_ssh_public_key_list",{"_15":16,"_17":351,"_19":352,"_21":353},"/v1/instances/{instance}/ssh-public-keys","List SSH public keys for instance","

List SSH public keys injected via cloud-init during instance creation. Note that this list is a snapshot in time and will not reflect updates made after the instance is created.

\n","instance_start",{"_15":24,"_17":356,"_19":357,"_21":-7},"/v1/instances/{instance}/start","Boot instance","instance_stop",{"_15":24,"_17":360,"_19":361,"_21":-7},"/v1/instances/{instance}/stop","Stop instance","instance_network_interface_list",{"_15":16,"_17":364,"_19":365,"_21":-7},"/v1/network-interfaces","List network interfaces","instance_network_interface_create",{"_15":24,"_17":364,"_19":368,"_21":-7},"Create network interface","instance_network_interface_view",{"_15":16,"_17":371,"_19":372,"_21":-7},"/v1/network-interfaces/{interface}","Fetch network interface","instance_network_interface_update",{"_15":32,"_17":371,"_19":375,"_21":-7},"Update network interface","instance_network_interface_delete",{"_15":36,"_17":371,"_19":378,"_21":379},"Delete network interface","

Note that the primary interface for an instance cannot be deleted if there are any secondary interfaces. A new primary interface must be designated first. The primary interface can be deleted if there are no secondary interfaces.

\n","login_saml",{"_15":24,"_17":382,"_19":383,"_21":-7},"/login/{silo_name}/saml/{provider_name}","Authenticate a user via SAML","login_local",{"_15":24,"_17":386,"_19":387,"_21":-7},"/v1/login/{silo_name}/local","Authenticate a user via username and password","silo_metric",{"_15":16,"_17":390,"_19":391,"_21":392},"/v1/metrics/{metric_name}","View metrics","

View CPU, memory, or storage utilization metrics at the silo or project level.

\n","system_policy_view",{"_15":16,"_17":395,"_19":396,"_21":-7},"/v1/system/policy","Fetch top-level IAM policy","system_policy_update",{"_15":32,"_17":395,"_19":399,"_21":-7},"Update top-level IAM policy","project_ip_pool_list",{"_15":16,"_17":402,"_19":403,"_21":-7},"/v1/ip-pools","List IP pools","project_ip_pool_view",{"_15":16,"_17":406,"_19":407,"_21":-7},"/v1/ip-pools/{pool}","Fetch IP pool","project_list",{"_15":16,"_17":410,"_19":411,"_21":-7},"/v1/projects","List projects","project_create",{"_15":24,"_17":410,"_19":414,"_21":-7},"Create project","project_view",{"_15":16,"_17":417,"_19":418,"_21":-7},"/v1/projects/{project}","Fetch project","project_update",{"_15":32,"_17":417,"_19":421,"_21":-7},"Update a project","project_delete",{"_15":36,"_17":417,"_19":424,"_21":-7},"Delete project","project_policy_view",{"_15":16,"_17":427,"_19":428,"_21":-7},"/v1/projects/{project}/policy","Fetch project's IAM policy","project_policy_update",{"_15":32,"_17":427,"_19":431,"_21":-7},"Update project's IAM policy","role_list",{"_15":16,"_17":434,"_19":435,"_21":-7},"/v1/system/roles","List built-in roles","role_view",{"_15":16,"_17":438,"_19":439,"_21":-7},"/v1/system/roles/{role_name}","Fetch built-in role","auth_settings_view",{"_15":16,"_17":442,"_19":443,"_21":-7},"/v1/auth-settings","Fetch current silo's auth settings","auth_settings_update",{"_15":32,"_17":442,"_19":446,"_21":-7},"Update current silo's auth settings","certificate_list",{"_15":16,"_17":449,"_19":450,"_21":451},"/v1/certificates","List certificates for external endpoints","

Returns a list of TLS certificates used for the external API (for the current Silo). These are sorted by creation date, with the most recent certificates appearing first.

\n","certificate_create",{"_15":24,"_17":449,"_19":454,"_21":455},"Create new system-wide x.509 certificate","

This certificate is automatically used by the Oxide Control plane to serve external connections.

\n","certificate_view",{"_15":16,"_17":458,"_19":459,"_21":460},"/v1/certificates/{certificate}","Fetch certificate","

Returns the details of a specific certificate

\n","certificate_delete",{"_15":36,"_17":458,"_19":463,"_21":464},"Delete certificate","

Permanently delete a certificate. This operation cannot be undone.

\n","group_list",{"_15":16,"_17":467,"_19":468,"_21":-7},"/v1/groups","List groups","group_view",{"_15":16,"_17":471,"_19":472,"_21":-7},"/v1/groups/{group_id}","Fetch group","policy_view",{"_15":16,"_17":475,"_19":476,"_21":-7},"/v1/policy","Fetch current silo's IAM policy","policy_update",{"_15":32,"_17":475,"_19":479,"_21":-7},"Update current silo's IAM policy","user_list",{"_15":16,"_17":482,"_19":483,"_21":-7},"/v1/users","List users","utilization_view",{"_15":16,"_17":486,"_19":487,"_21":-7},"/v1/utilization","Fetch resource utilization for user's current silo","snapshot_list",{"_15":16,"_17":490,"_19":491,"_21":-7},"/v1/snapshots","List snapshots","snapshot_create",{"_15":24,"_17":490,"_19":494,"_21":495},"Create snapshot","

Creates a point-in-time snapshot from a disk.

\n","snapshot_view",{"_15":16,"_17":498,"_19":499,"_21":-7},"/v1/snapshots/{snapshot}","Fetch snapshot","snapshot_delete",{"_15":36,"_17":498,"_19":502,"_21":-7},"Delete snapshot","alert_class_list",{"_15":16,"_17":505,"_19":506,"_21":-7},"/v1/alert-classes","List alert classes","alert_receiver_list",{"_15":16,"_17":509,"_19":510,"_21":-7},"/v1/alert-receivers","List alert receivers","alert_receiver_view",{"_15":16,"_17":513,"_19":514,"_21":-7},"/v1/alert-receivers/{receiver}","Fetch alert receiver","alert_receiver_delete",{"_15":36,"_17":513,"_19":517,"_21":-7},"Delete alert receiver","alert_delivery_list",{"_15":16,"_17":520,"_19":521,"_21":522},"/v1/alert-receivers/{receiver}/deliveries","List delivery attempts to alert receiver","

Optional query parameters to this endpoint may be used to filter deliveries by state. If none of the failed, pending or delivered query parameters are present, all deliveries are returned. If one or more of these parameters are provided, only those which are set to "true" are included in the response.

\n","alert_receiver_probe",{"_15":24,"_17":525,"_19":526,"_21":527},"/v1/alert-receivers/{receiver}/probe","Send liveness probe to alert receiver","

This endpoint synchronously sends a liveness probe to the selected alert receiver. The response message describes the outcome of the probe: either the successful response (as appropriate), or indication of why the probe failed.

The result of the probe is represented as an AlertDelivery model. Details relating to the status of the probe depend on the alert delivery mechanism, and are included in the AlertDeliveryAttempts model. For example, webhook receiver liveness probes include the HTTP status code returned by the receiver endpoint.

Note that the response status is 200 OK as long as a probe request was able to be sent to the receiver endpoint. If an HTTP-based receiver, such as a webhook, responds to the another status code, including an error, this will be indicated by the response body, not the status of the response.

The resend query parameter can be used to request re-delivery of failed events if the liveness probe succeeds. If it is set to true and the liveness probe succeeds, any alerts for which delivery to this receiver has failed will be queued for re-delivery.

\n","alert_receiver_subscription_add",{"_15":24,"_17":530,"_19":531,"_21":-7},"/v1/alert-receivers/{receiver}/subscriptions","Add alert receiver subscription","alert_receiver_subscription_remove",{"_15":36,"_17":534,"_19":535,"_21":-7},"/v1/alert-receivers/{receiver}/subscriptions/{subscription}","Remove alert receiver subscription","alert_delivery_resend",{"_15":24,"_17":538,"_19":539,"_21":-7},"/v1/alerts/{alert_id}/resend","Request re-delivery of alert","webhook_receiver_create",{"_15":24,"_17":542,"_19":543,"_21":-7},"/v1/webhook-receivers","Create webhook receiver","webhook_receiver_update",{"_15":32,"_17":546,"_19":547,"_21":548},"/v1/webhook-receivers/{receiver}","Update webhook receiver","

Note that receiver secrets are NOT added or removed using this endpoint. Instead, use the /v1/webhooks/{secrets}/?receiver={receiver} endpoint to add and remove secrets.

\n","webhook_secrets_list",{"_15":16,"_17":551,"_19":552,"_21":-7},"/v1/webhook-secrets","List webhook receiver secret IDs","webhook_secrets_add",{"_15":24,"_17":551,"_19":555,"_21":-7},"Add secret to webhook receiver","webhook_secrets_delete",{"_15":36,"_17":558,"_19":559,"_21":-7},"/v1/webhook-secrets/{secret_id}","Remove secret from webhook receiver","physical_disk_list",{"_15":16,"_17":562,"_19":563,"_21":-7},"/v1/system/hardware/disks","List physical disks","physical_disk_view",{"_15":16,"_17":566,"_19":567,"_21":-7},"/v1/system/hardware/disks/{disk_id}","Get a physical disk","rack_list",{"_15":16,"_17":570,"_19":571,"_21":-7},"/v1/system/hardware/racks","List racks","rack_view",{"_15":16,"_17":574,"_19":575,"_21":-7},"/v1/system/hardware/racks/{rack_id}","Fetch rack","sled_list",{"_15":16,"_17":578,"_19":579,"_21":-7},"/v1/system/hardware/sleds","List sleds","sled_add",{"_15":24,"_17":578,"_19":582,"_21":-7},"Add sled to initialized rack","sled_view",{"_15":16,"_17":585,"_19":586,"_21":-7},"/v1/system/hardware/sleds/{sled_id}","Fetch sled","sled_physical_disk_list",{"_15":16,"_17":589,"_19":590,"_21":-7},"/v1/system/hardware/sleds/{sled_id}/disks","List physical disks attached to sleds","sled_instance_list",{"_15":16,"_17":593,"_19":594,"_21":-7},"/v1/system/hardware/sleds/{sled_id}/instances","List instances running on given sled","sled_set_provision_policy",{"_15":32,"_17":597,"_19":598,"_21":-7},"/v1/system/hardware/sleds/{sled_id}/provision-policy","Set sled provision policy","sled_list_uninitialized",{"_15":16,"_17":601,"_19":602,"_21":-7},"/v1/system/hardware/sleds-uninitialized","List uninitialized sleds","networking_switch_port_list",{"_15":16,"_17":605,"_19":606,"_21":-7},"/v1/system/hardware/switch-port","List switch ports","networking_switch_port_apply_settings",{"_15":24,"_17":609,"_19":610,"_21":-7},"/v1/system/hardware/switch-port/{port}/settings","Apply switch port settings","networking_switch_port_clear_settings",{"_15":36,"_17":609,"_19":613,"_21":-7},"Clear switch port settings","networking_switch_port_status",{"_15":16,"_17":616,"_19":617,"_21":-7},"/v1/system/hardware/switch-port/{port}/status","Get switch port status","switch_list",{"_15":16,"_17":620,"_19":621,"_21":-7},"/v1/system/hardware/switches","List switches","switch_view",{"_15":16,"_17":624,"_19":625,"_21":-7},"/v1/system/hardware/switches/{switch_id}","Fetch switch","ip_pool_list",{"_15":16,"_17":628,"_19":403,"_21":-7},"/v1/system/ip-pools","ip_pool_create",{"_15":24,"_17":628,"_19":631,"_21":-7},"Create IP pool","ip_pool_view",{"_15":16,"_17":634,"_19":407,"_21":-7},"/v1/system/ip-pools/{pool}","ip_pool_update",{"_15":32,"_17":634,"_19":637,"_21":-7},"Update IP pool","ip_pool_delete",{"_15":36,"_17":634,"_19":640,"_21":-7},"Delete IP pool","ip_pool_range_list",{"_15":16,"_17":643,"_19":644,"_21":645},"/v1/system/ip-pools/{pool}/ranges","List ranges for IP pool","

Ranges are ordered by their first address.

\n","ip_pool_range_add",{"_15":24,"_17":648,"_19":649,"_21":650},"/v1/system/ip-pools/{pool}/ranges/add","Add range to IP pool","

IPv6 ranges are not allowed yet.

\n","ip_pool_range_remove",{"_15":24,"_17":653,"_19":654,"_21":-7},"/v1/system/ip-pools/{pool}/ranges/remove","Remove range from IP pool","ip_pool_silo_list",{"_15":16,"_17":657,"_19":658,"_21":-7},"/v1/system/ip-pools/{pool}/silos","List IP pool's linked silos","ip_pool_silo_link",{"_15":24,"_17":657,"_19":661,"_21":662},"Link IP pool to silo","

Users in linked silos can allocate external IPs from this pool for their instances. A silo can have at most one default pool. IPs are allocated from the default pool when users ask for one without specifying a pool.

\n","ip_pool_silo_update",{"_15":32,"_17":665,"_19":666,"_21":667},"/v1/system/ip-pools/{pool}/silos/{silo}","Make IP pool default for silo","

When a user asks for an IP (e.g., at instance create time) without specifying a pool, the IP comes from the default pool if a default is configured. When a pool is made the default for a silo, any existing default will remain linked to the silo, but will no longer be the default.

\n","ip_pool_silo_unlink",{"_15":36,"_17":665,"_19":670,"_21":671},"Unlink IP pool from silo","

Will fail if there are any outstanding IPs allocated in the silo.

\n","ip_pool_utilization_view",{"_15":16,"_17":674,"_19":675,"_21":-7},"/v1/system/ip-pools/{pool}/utilization","Fetch IP pool utilization","ip_pool_service_view",{"_15":16,"_17":678,"_19":679,"_21":-7},"/v1/system/ip-pools-service","Fetch Oxide service IP pool","ip_pool_service_range_list",{"_15":16,"_17":682,"_19":683,"_21":645},"/v1/system/ip-pools-service/ranges","List IP ranges for the Oxide service pool","ip_pool_service_range_add",{"_15":24,"_17":686,"_19":687,"_21":650},"/v1/system/ip-pools-service/ranges/add","Add IP range to Oxide service pool","ip_pool_service_range_remove",{"_15":24,"_17":690,"_19":691,"_21":-7},"/v1/system/ip-pools-service/ranges/remove","Remove IP range from Oxide service pool","system_metric",{"_15":16,"_17":694,"_19":391,"_21":695},"/v1/system/metrics/{metric_name}","

View CPU, memory, or storage utilization metrics at the fleet or silo level.

\n","system_timeseries_query",{"_15":24,"_17":698,"_19":699,"_21":700},"/v1/system/timeseries/query","Run timeseries query","

Queries are written in OxQL.

\n","system_timeseries_schema_list",{"_15":16,"_17":703,"_19":704,"_21":-7},"/v1/system/timeseries/schemas","List timeseries schemas","networking_switch_port_lldp_neighbors",{"_15":16,"_17":707,"_19":708,"_21":-7},"/v1/system/hardware/rack-switch-port/{rack_id}/{switch_location}/{port}/lldp/neighbors","Fetch the LLDP neighbors seen on a switch port","networking_switch_port_lldp_config_view",{"_15":16,"_17":711,"_19":712,"_21":-7},"/v1/system/hardware/switch-port/{port}/lldp/config","Fetch the LLDP configuration for a switch port","networking_switch_port_lldp_config_update",{"_15":24,"_17":711,"_19":715,"_21":-7},"Update the LLDP configuration for a switch port","networking_address_lot_list",{"_15":16,"_17":718,"_19":719,"_21":-7},"/v1/system/networking/address-lot","List address lots","networking_address_lot_create",{"_15":24,"_17":718,"_19":722,"_21":-7},"Create address lot","networking_address_lot_delete",{"_15":36,"_17":725,"_19":726,"_21":-7},"/v1/system/networking/address-lot/{address_lot}","Delete address lot","networking_address_lot_block_list",{"_15":16,"_17":729,"_19":730,"_21":-7},"/v1/system/networking/address-lot/{address_lot}/blocks","List blocks in address lot","networking_allow_list_view",{"_15":16,"_17":733,"_19":734,"_21":-7},"/v1/system/networking/allow-list","Get user-facing services IP allowlist","networking_allow_list_update",{"_15":32,"_17":733,"_19":737,"_21":-7},"Update user-facing services IP allowlist","networking_bfd_disable",{"_15":24,"_17":740,"_19":741,"_21":-7},"/v1/system/networking/bfd-disable","Disable a BFD session","networking_bfd_enable",{"_15":24,"_17":744,"_19":745,"_21":-7},"/v1/system/networking/bfd-enable","Enable a BFD session","networking_bfd_status",{"_15":16,"_17":748,"_19":749,"_21":-7},"/v1/system/networking/bfd-status","Get BFD status","networking_bgp_config_list",{"_15":16,"_17":752,"_19":753,"_21":-7},"/v1/system/networking/bgp","List BGP configurations","networking_bgp_config_create",{"_15":24,"_17":752,"_19":756,"_21":-7},"Create new BGP configuration","networking_bgp_config_delete",{"_15":36,"_17":752,"_19":759,"_21":-7},"Delete BGP configuration","networking_bgp_announce_set_list",{"_15":16,"_17":762,"_19":763,"_21":-7},"/v1/system/networking/bgp-announce-set","List BGP announce sets","networking_bgp_announce_set_update",{"_15":32,"_17":762,"_19":766,"_21":767},"Update BGP announce set","

If the announce set exists, this endpoint replaces the existing announce set with the one specified.

\n","networking_bgp_announce_set_delete",{"_15":36,"_17":770,"_19":771,"_21":-7},"/v1/system/networking/bgp-announce-set/{announce_set}","Delete BGP announce set","networking_bgp_announcement_list",{"_15":16,"_17":774,"_19":775,"_21":-7},"/v1/system/networking/bgp-announce-set/{announce_set}/announcement","Get originated routes for a specified BGP announce set","networking_bgp_exported",{"_15":16,"_17":778,"_19":779,"_21":-7},"/v1/system/networking/bgp-exported","Get BGP exported routes","networking_bgp_message_history",{"_15":16,"_17":782,"_19":783,"_21":-7},"/v1/system/networking/bgp-message-history","Get BGP router message history","networking_bgp_imported_routes_ipv4",{"_15":16,"_17":786,"_19":787,"_21":-7},"/v1/system/networking/bgp-routes-ipv4","Get imported IPv4 BGP routes","networking_bgp_status",{"_15":16,"_17":790,"_19":791,"_21":-7},"/v1/system/networking/bgp-status","Get BGP peer status","networking_loopback_address_list",{"_15":16,"_17":794,"_19":795,"_21":-7},"/v1/system/networking/loopback-address","List loopback addresses","networking_loopback_address_create",{"_15":24,"_17":794,"_19":798,"_21":-7},"Create loopback address","networking_loopback_address_delete",{"_15":36,"_17":801,"_19":802,"_21":-7},"/v1/system/networking/loopback-address/{rack_id}/{switch_location}/{address}/{subnet_mask}","Delete loopback address","networking_switch_port_settings_list",{"_15":16,"_17":805,"_19":806,"_21":-7},"/v1/system/networking/switch-port-settings","List switch port settings","networking_switch_port_settings_create",{"_15":24,"_17":805,"_19":809,"_21":-7},"Create switch port settings","networking_switch_port_settings_delete",{"_15":36,"_17":805,"_19":812,"_21":-7},"Delete switch port settings","networking_switch_port_settings_view",{"_15":16,"_17":815,"_19":816,"_21":-7},"/v1/system/networking/switch-port-settings/{port}","Get information about switch port","silo_identity_provider_list",{"_15":16,"_17":819,"_19":820,"_21":821},"/v1/system/identity-providers","List identity providers for silo","

List identity providers for silo by silo name or ID.

\n","local_idp_user_create",{"_15":24,"_17":824,"_19":825,"_21":826},"/v1/system/identity-providers/local/users","Create user","

Users can only be created in Silos with provision_type == Fixed. Otherwise, Silo users are just-in-time (JIT) provisioned when a user first logs in using an external Identity Provider.

\n","local_idp_user_delete",{"_15":36,"_17":829,"_19":830,"_21":-7},"/v1/system/identity-providers/local/users/{user_id}","Delete user","local_idp_user_set_password",{"_15":24,"_17":833,"_19":834,"_21":835},"/v1/system/identity-providers/local/users/{user_id}/set-password","Set or invalidate user's password","

Passwords can only be updated for users in Silos with identity mode LocalOnly.

\n","saml_identity_provider_create",{"_15":24,"_17":838,"_19":839,"_21":-7},"/v1/system/identity-providers/saml","Create SAML identity provider","saml_identity_provider_view",{"_15":16,"_17":842,"_19":843,"_21":-7},"/v1/system/identity-providers/saml/{provider}","Fetch SAML identity provider","system_quotas_list",{"_15":16,"_17":846,"_19":847,"_21":-7},"/v1/system/silo-quotas","Lists resource quotas for all silos","silo_list",{"_15":16,"_17":850,"_19":851,"_21":852},"/v1/system/silos","List silos","

Lists silos that are discoverable based on the current permissions.

\n","silo_create",{"_15":24,"_17":850,"_19":855,"_21":-7},"Create a silo","silo_view",{"_15":16,"_17":858,"_19":859,"_21":860},"/v1/system/silos/{silo}","Fetch silo","

Fetch silo by name or ID.

\n","silo_delete",{"_15":36,"_17":858,"_19":863,"_21":864},"Delete a silo","

Delete a silo by name or ID.

\n","silo_ip_pool_list",{"_15":16,"_17":867,"_19":868,"_21":869},"/v1/system/silos/{silo}/ip-pools","List IP pools linked to silo","

Linked IP pools are available to users in the specified silo. A silo can have at most one default pool. IPs are allocated from the default pool when users ask for one without specifying a pool.

\n","silo_policy_view",{"_15":16,"_17":872,"_19":873,"_21":-7},"/v1/system/silos/{silo}/policy","Fetch silo IAM policy","silo_policy_update",{"_15":32,"_17":872,"_19":876,"_21":-7},"Update silo IAM policy","silo_quotas_view",{"_15":16,"_17":879,"_19":880,"_21":-7},"/v1/system/silos/{silo}/quotas","Fetch resource quotas for silo","silo_quotas_update",{"_15":32,"_17":879,"_19":883,"_21":884},"Update resource quotas for silo","

If a quota value is not specified, it will remain unchanged.

\n","silo_user_list",{"_15":16,"_17":887,"_19":888,"_21":-7},"/v1/system/users","List built-in (system) users in silo","silo_user_view",{"_15":16,"_17":891,"_19":892,"_21":-7},"/v1/system/users/{user_id}","Fetch built-in (system) user","user_builtin_list",{"_15":16,"_17":895,"_19":896,"_21":-7},"/v1/system/users-builtin","List built-in users","user_builtin_view",{"_15":16,"_17":899,"_19":900,"_21":-7},"/v1/system/users-builtin/{user}","Fetch built-in user","silo_utilization_list",{"_15":16,"_17":903,"_19":904,"_21":-7},"/v1/system/utilization/silos","List current utilization state for all silos","silo_utilization_view",{"_15":16,"_17":907,"_19":908,"_21":-7},"/v1/system/utilization/silos/{silo}","Fetch current utilization for given silo","ping",{"_15":16,"_17":911,"_19":912,"_21":913},"/v1/ping","Ping API","

Always responds with Ok if it responds at all.

\n","current_user_access_token_list",{"_15":16,"_17":916,"_19":917,"_21":918},"/v1/me/access-tokens","List access tokens","

List device access tokens for the currently authenticated user.

\n","current_user_access_token_delete",{"_15":36,"_17":921,"_19":922,"_21":923},"/v1/me/access-tokens/{token_id}","Delete access token","

Delete a device access token for the currently authenticated user.

\n","internet_gateway_ip_address_list",{"_15":16,"_17":926,"_19":927,"_21":-7},"/v1/internet-gateway-ip-addresses","List IP addresses attached to internet gateway","internet_gateway_ip_address_create",{"_15":24,"_17":926,"_19":930,"_21":-7},"Attach IP address to internet gateway","internet_gateway_ip_address_delete",{"_15":36,"_17":933,"_19":934,"_21":-7},"/v1/internet-gateway-ip-addresses/{address}","Detach IP address from internet gateway","internet_gateway_ip_pool_list",{"_15":16,"_17":937,"_19":938,"_21":-7},"/v1/internet-gateway-ip-pools","List IP pools attached to internet gateway","internet_gateway_ip_pool_create",{"_15":24,"_17":937,"_19":941,"_21":-7},"Attach IP pool to internet gateway","internet_gateway_ip_pool_delete",{"_15":36,"_17":944,"_19":945,"_21":-7},"/v1/internet-gateway-ip-pools/{pool}","Detach IP pool from internet gateway","internet_gateway_list",{"_15":16,"_17":948,"_19":949,"_21":-7},"/v1/internet-gateways","List internet gateways","internet_gateway_create",{"_15":24,"_17":948,"_19":952,"_21":-7},"Create VPC internet gateway","internet_gateway_view",{"_15":16,"_17":955,"_19":956,"_21":-7},"/v1/internet-gateways/{gateway}","Fetch internet gateway","internet_gateway_delete",{"_15":36,"_17":955,"_19":959,"_21":-7},"Delete internet gateway","vpc_firewall_rules_view",{"_15":16,"_17":962,"_19":963,"_21":-7},"/v1/vpc-firewall-rules","List firewall rules","vpc_firewall_rules_update",{"_15":32,"_17":962,"_19":966,"_21":967},"Replace firewall rules","

The maximum number of rules per VPC is 1024.

Targets are used to specify the set of instances to which a firewall rule applies. You can target instances directly by name, or specify a VPC, VPC subnet, IP, or IP subnet, which will apply the rule to traffic going to all matching instances. Targets are additive: the rule applies to instances matching ANY target. The maximum number of targets is 256.

Filters reduce the scope of a firewall rule. Without filters, the rule applies to all packets to the targets (or from the targets, if it's an outbound rule). With multiple filters, the rule applies only to packets matching ALL filters. The maximum number of each type of filter is 256.

\n","vpc_router_route_list",{"_15":16,"_17":970,"_19":971,"_21":972},"/v1/vpc-router-routes","List routes","

List the routes associated with a router in a particular VPC.

\n","vpc_router_route_create",{"_15":24,"_17":970,"_19":975,"_21":-7},"Create route","vpc_router_route_view",{"_15":16,"_17":978,"_19":979,"_21":-7},"/v1/vpc-router-routes/{route}","Fetch route","vpc_router_route_update",{"_15":32,"_17":978,"_19":982,"_21":-7},"Update route","vpc_router_route_delete",{"_15":36,"_17":978,"_19":985,"_21":-7},"Delete route","vpc_router_list",{"_15":16,"_17":988,"_19":989,"_21":-7},"/v1/vpc-routers","List routers","vpc_router_create",{"_15":24,"_17":988,"_19":992,"_21":-7},"Create VPC router","vpc_router_view",{"_15":16,"_17":995,"_19":996,"_21":-7},"/v1/vpc-routers/{router}","Fetch router","vpc_router_update",{"_15":32,"_17":995,"_19":999,"_21":-7},"Update router","vpc_router_delete",{"_15":36,"_17":995,"_19":1002,"_21":-7},"Delete router","vpc_subnet_list",{"_15":16,"_17":1005,"_19":1006,"_21":-7},"/v1/vpc-subnets","List subnets","vpc_subnet_create",{"_15":24,"_17":1005,"_19":1009,"_21":-7},"Create subnet","vpc_subnet_view",{"_15":16,"_17":1012,"_19":1013,"_21":-7},"/v1/vpc-subnets/{subnet}","Fetch subnet","vpc_subnet_update",{"_15":32,"_17":1012,"_19":1016,"_21":-7},"Update subnet","vpc_subnet_delete",{"_15":36,"_17":1012,"_19":1019,"_21":-7},"Delete subnet","vpc_subnet_list_network_interfaces",{"_15":16,"_17":1022,"_19":365,"_21":-7},"/v1/vpc-subnets/{subnet}/network-interfaces","vpc_list",{"_15":16,"_17":1025,"_19":1026,"_21":-7},"/v1/vpcs","List VPCs","vpc_create",{"_15":24,"_17":1025,"_19":1029,"_21":-7},"Create VPC","vpc_view",{"_15":16,"_17":1032,"_19":1033,"_21":-7},"/v1/vpcs/{vpc}","Fetch VPC","vpc_update",{"_15":32,"_17":1032,"_19":1036,"_21":-7},"Update a VPC","vpc_delete",{"_15":36,"_17":1032,"_19":1039,"_21":-7},"Delete VPC","routes/api",{"_1042":1043,"_1044":1045,"_1052":1053,"_1073":1074},"version","20250604.0.0","commit",{"_1046":1047,"_1048":1049,"_1050":1051},"sha","2e3a662b6d3ac93d1e2d0203664c860a66b3b2f3","jsonUrl","https://github.com/oxidecomputer/omicron/blob/2e3a662b6d3ac93d1e2d0203664c860a66b3b2f3/openapi/nexus.json","repoUrl","https://github.com/oxidecomputer/omicron/commit/2e3a662b6d3ac93d1e2d0203664c860a66b3b2f3","guides",[1054,1058,1061,1064,1067,1070],{"_17":1055,"_1056":1057},"/api/guides/introduction","title","Introduction",{"_17":1059,"_1056":1060},"/guides/key-entities-and-concepts","Key Concepts",{"_17":1062,"_1056":1063},"/api/guides/authentication","Authentication",{"_17":1065,"_1056":1066},"/api/guides/resource-identifiers","Resource Identifiers",{"_17":1068,"_1056":1069},"/api/guides/responses","Responses",{"_17":1071,"_1056":1072},"/api/guides/sdks","SDKs","methods",[1075,1090,1097,1106,1118,1149,1159,1168,1194,1199,1203,1208,1220,1225,1240,1247,1264,1284,1304,1310,1343,1368,1372,1377],{"_1076":1077,"_1078":1079},"name","affinity","tags",[1080,1082,1083,1084,1085,1086,1087,1088,1089],{"_1081":13,"_19":20},"operationId",{"_1081":22,"_19":25},{"_1081":26,"_19":29},{"_1081":30,"_19":33},{"_1081":34,"_19":37},{"_1081":38,"_19":41},{"_1081":42,"_19":45},{"_1081":46,"_19":48},{"_1081":49,"_19":51},{"_1076":1091,"_1078":1092},"console-auth",[1093,1094,1095,1096],{"_1081":52,"_19":55},{"_1081":57,"_19":60},{"_1081":62,"_19":65},{"_1081":67,"_19":70},{"_1076":1098,"_1078":1099},"current-user",[1100,1101,1102,1103,1104,1105],{"_1081":71,"_19":74},{"_1081":75,"_19":78},{"_1081":79,"_19":82},{"_1081":84,"_19":86},{"_1081":88,"_19":91},{"_1081":93,"_19":95},{"_1076":1107,"_1078":1108},"disks",[1109,1110,1111,1112,1113,1114,1115,1116,1117],{"_1081":97,"_19":100},{"_1081":101,"_19":103},{"_1081":104,"_19":107},{"_1081":108,"_19":110},{"_1081":111,"_19":114},{"_1081":115,"_19":118},{"_1081":120,"_19":123},{"_1081":125,"_19":128},{"_1081":129,"_19":132},{"_1076":1119,"_1078":1120},"experimental",[1121,1122,1123,1124,1125,1126,1127,1128,1129,1130,1131,1132,1133,1134,1135,1136,1137,1138,1139,1140,1141,1142,1143,1144,1145,1146,1147,1148],{"_1081":133,"_19":136},{"_1081":137,"_19":139},{"_1081":140,"_19":143},{"_1081":144,"_19":146},{"_1081":147,"_19":150},{"_1081":151,"_19":153},{"_1081":154,"_19":157},{"_1081":158,"_19":160},{"_1081":162,"_19":165},{"_1081":166,"_19":169},{"_1081":170,"_19":173},{"_1081":174,"_19":176},{"_1081":177,"_19":180},{"_1081":181,"_19":184},{"_1081":185,"_19":187},{"_1081":188,"_19":191},{"_1081":192,"_19":194},{"_1081":195,"_19":197},{"_1081":198,"_19":201},{"_1081":202,"_19":205},{"_1081":206,"_19":208},{"_1081":209,"_19":211},{"_1081":212,"_19":215},{"_1081":216,"_19":219},{"_1081":220,"_19":223},{"_1081":225,"_19":228},{"_1081":230,"_19":232},{"_1081":234,"_19":237},{"_1076":1150,"_1078":1151},"floating-ips",[1152,1153,1154,1155,1156,1157,1158],{"_1081":239,"_19":242},{"_1081":243,"_19":245},{"_1081":246,"_19":249},{"_1081":250,"_19":252},{"_1081":253,"_19":255},{"_1081":256,"_19":259},{"_1081":261,"_19":264},{"_1076":1160,"_1078":1161},"images",[1162,1163,1164,1165,1166,1167],{"_1081":265,"_19":268},{"_1081":270,"_19":272},{"_1081":274,"_19":277},{"_1081":279,"_19":281},{"_1081":283,"_19":286},{"_1081":288,"_19":291},{"_1076":1169,"_1078":1170},"instances",[1171,1172,1173,1174,1175,1176,1177,1178,1179,1180,1181,1182,1183,1184,1185,1186,1187,1188,1189,1190,1191,1192,1193],{"_1081":293,"_19":296},{"_1081":297,"_19":299},{"_1081":300,"_19":303},{"_1081":304,"_19":306},{"_1081":307,"_19":309},{"_1081":310,"_19":313},{"_1081":314,"_19":317},{"_1081":318,"_19":321},{"_1081":322,"_19":325},{"_1081":326,"_19":329},{"_1081":330,"_19":333},{"_1081":334,"_19":336},{"_1081":337,"_19":340},{"_1081":341,"_19":344},{"_1081":345,"_19":348},{"_1081":349,"_19":352},{"_1081":354,"_19":357},{"_1081":358,"_19":361},{"_1081":362,"_19":365},{"_1081":366,"_19":368},{"_1081":369,"_19":372},{"_1081":373,"_19":375},{"_1081":376,"_19":378},{"_1076":1195,"_1078":1196},"login",[1197,1198],{"_1081":380,"_19":383},{"_1081":384,"_19":387},{"_1076":1200,"_1078":1201},"metrics",[1202],{"_1081":388,"_19":391},{"_1076":1204,"_1078":1205},"policy",[1206,1207],{"_1081":393,"_19":396},{"_1081":397,"_19":399},{"_1076":1209,"_1078":1210},"projects",[1211,1212,1213,1214,1215,1216,1217,1218,1219],{"_1081":400,"_19":403},{"_1081":404,"_19":407},{"_1081":408,"_19":411},{"_1081":412,"_19":414},{"_1081":415,"_19":418},{"_1081":419,"_19":421},{"_1081":422,"_19":424},{"_1081":425,"_19":428},{"_1081":429,"_19":431},{"_1076":1221,"_1078":1222},"roles",[1223,1224],{"_1081":432,"_19":435},{"_1081":436,"_19":439},{"_1076":1226,"_1078":1227},"silos",[1228,1229,1230,1231,1232,1233,1234,1235,1236,1237,1238,1239],{"_1081":440,"_19":443},{"_1081":444,"_19":446},{"_1081":447,"_19":450},{"_1081":452,"_19":454},{"_1081":456,"_19":459},{"_1081":461,"_19":463},{"_1081":465,"_19":468},{"_1081":469,"_19":472},{"_1081":473,"_19":476},{"_1081":477,"_19":479},{"_1081":480,"_19":483},{"_1081":484,"_19":487},{"_1076":1241,"_1078":1242},"snapshots",[1243,1244,1245,1246],{"_1081":488,"_19":491},{"_1081":492,"_19":494},{"_1081":496,"_19":499},{"_1081":500,"_19":502},{"_1076":1248,"_1078":1249},"system/alerts",[1250,1251,1252,1253,1254,1255,1256,1257,1258,1259,1260,1261,1262,1263],{"_1081":503,"_19":506},{"_1081":507,"_19":510},{"_1081":511,"_19":514},{"_1081":515,"_19":517},{"_1081":518,"_19":521},{"_1081":523,"_19":526},{"_1081":528,"_19":531},{"_1081":532,"_19":535},{"_1081":536,"_19":539},{"_1081":540,"_19":543},{"_1081":544,"_19":547},{"_1081":549,"_19":552},{"_1081":553,"_19":555},{"_1081":556,"_19":559},{"_1076":1265,"_1078":1266},"system/hardware",[1267,1268,1269,1270,1271,1272,1273,1274,1275,1276,1277,1278,1279,1280,1281,1282,1283],{"_1081":560,"_19":563},{"_1081":564,"_19":567},{"_1081":568,"_19":571},{"_1081":572,"_19":575},{"_1081":576,"_19":579},{"_1081":580,"_19":582},{"_1081":583,"_19":586},{"_1081":587,"_19":590},{"_1081":591,"_19":594},{"_1081":595,"_19":598},{"_1081":599,"_19":602},{"_1081":603,"_19":606},{"_1081":607,"_19":610},{"_1081":611,"_19":613},{"_1081":614,"_19":617},{"_1081":618,"_19":621},{"_1081":622,"_19":625},{"_1076":1285,"_1078":1286},"system/ip-pools",[1287,1288,1289,1290,1291,1292,1293,1294,1295,1296,1297,1298,1299,1300,1301,1302,1303],{"_1081":626,"_19":403},{"_1081":629,"_19":631},{"_1081":632,"_19":407},{"_1081":635,"_19":637},{"_1081":638,"_19":640},{"_1081":641,"_19":644},{"_1081":646,"_19":649},{"_1081":651,"_19":654},{"_1081":655,"_19":658},{"_1081":659,"_19":661},{"_1081":663,"_19":666},{"_1081":668,"_19":670},{"_1081":672,"_19":675},{"_1081":676,"_19":679},{"_1081":680,"_19":683},{"_1081":684,"_19":687},{"_1081":688,"_19":691},{"_1076":1305,"_1078":1306},"system/metrics",[1307,1308,1309],{"_1081":692,"_19":391},{"_1081":696,"_19":699},{"_1081":701,"_19":704},{"_1076":1311,"_1078":1312},"system/networking",[1313,1314,1315,1316,1317,1318,1319,1320,1321,1322,1323,1324,1325,1326,1327,1328,1329,1330,1331,1332,1333,1334,1335,1336,1337,1338,1339,1340,1341,1342],{"_1081":705,"_19":708},{"_1081":709,"_19":712},{"_1081":713,"_19":715},{"_1081":716,"_19":719},{"_1081":720,"_19":722},{"_1081":723,"_19":726},{"_1081":727,"_19":730},{"_1081":731,"_19":734},{"_1081":735,"_19":737},{"_1081":738,"_19":741},{"_1081":742,"_19":745},{"_1081":746,"_19":749},{"_1081":750,"_19":753},{"_1081":754,"_19":756},{"_1081":757,"_19":759},{"_1081":760,"_19":763},{"_1081":764,"_19":766},{"_1081":768,"_19":771},{"_1081":772,"_19":775},{"_1081":776,"_19":779},{"_1081":780,"_19":783},{"_1081":784,"_19":787},{"_1081":788,"_19":791},{"_1081":792,"_19":795},{"_1081":796,"_19":798},{"_1081":799,"_19":802},{"_1081":803,"_19":806},{"_1081":807,"_19":809},{"_1081":810,"_19":812},{"_1081":813,"_19":816},{"_1076":1344,"_1078":1345},"system/silos",[1346,1347,1348,1349,1350,1351,1352,1353,1354,1355,1356,1357,1358,1359,1360,1361,1362,1363,1364,1365,1366,1367],{"_1081":817,"_19":820},{"_1081":822,"_19":825},{"_1081":827,"_19":830},{"_1081":831,"_19":834},{"_1081":836,"_19":839},{"_1081":840,"_19":843},{"_1081":844,"_19":847},{"_1081":848,"_19":851},{"_1081":853,"_19":855},{"_1081":856,"_19":859},{"_1081":861,"_19":863},{"_1081":865,"_19":868},{"_1081":870,"_19":873},{"_1081":874,"_19":876},{"_1081":877,"_19":880},{"_1081":881,"_19":883},{"_1081":885,"_19":888},{"_1081":889,"_19":892},{"_1081":893,"_19":896},{"_1081":897,"_19":900},{"_1081":901,"_19":904},{"_1081":905,"_19":908},{"_1076":1369,"_1078":1370},"system/status",[1371],{"_1081":909,"_19":912},{"_1076":1373,"_1078":1374},"tokens",[1375,1376],{"_1081":914,"_19":917},{"_1081":919,"_19":922},{"_1076":1378,"_1078":1379},"vpcs",[1380,1381,1382,1383,1384,1385,1386,1387,1388,1389,1390,1391,1392,1393,1394,1395,1396,1397,1398,1399,1400,1401,1402,1403,1404,1405,1406,1407,1408,1409,1410,1411,1412],{"_1081":924,"_19":927},{"_1081":928,"_19":930},{"_1081":931,"_19":934},{"_1081":935,"_19":938},{"_1081":939,"_19":941},{"_1081":942,"_19":945},{"_1081":946,"_19":949},{"_1081":950,"_19":952},{"_1081":953,"_19":956},{"_1081":957,"_19":959},{"_1081":960,"_19":963},{"_1081":964,"_19":966},{"_1081":968,"_19":971},{"_1081":973,"_19":975},{"_1081":976,"_19":979},{"_1081":980,"_19":982},{"_1081":983,"_19":985},{"_1081":986,"_19":989},{"_1081":990,"_19":992},{"_1081":993,"_19":996},{"_1081":997,"_19":999},{"_1081":1000,"_19":1002},{"_1081":1003,"_19":1006},{"_1081":1007,"_19":1009},{"_1081":1010,"_19":1013},{"_1081":1014,"_19":1016},{"_1081":1017,"_19":1019},{"_1081":1020,"_19":365},{"_1081":1023,"_19":1026},{"_1081":1027,"_19":1029},{"_1081":1030,"_19":1033},{"_1081":1034,"_19":1036},{"_1081":1037,"_19":1039},"routes/api.$slug",{"_1415":1416},"tag",{"_15":24,"_1417":1418,"_17":551},"method",{"_1078":1419,"_19":555,"_1081":553,"_1420":1421,"_1452":1453,"_1466":1467,"_17":551},[1248],"parameters",[1422],{"_1423":1424,"_1076":1425,"_21":1426,"_1427":1428,"_1429":1430},"in","query","receiver","

The name or ID of the webhook receiver.

\n","required",true,"schema",{"_1431":1432},"oneOf",[1433,1441],{"_1056":1434,"_1435":1436},"id","allOf",[1437],{"_15":1438,"_1439":1440},"string","format","uuid",{"_1056":1076,"_1435":1442},[1443],{"_1056":1444,"_21":1445,"_15":1438,"_1446":1447,"_1448":1449,"_1450":1451},"A name unique within the parent collection","

Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Names cannot be a UUID, but they may contain a UUID. They can be at most 63 characters long.

\n","pattern","^(?![0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)^[a-z]([a-zA-Z0-9-]*[a-zA-Z0-9]+)?$","minLength",1,"maxLength",63,"requestBody",{"_1454":1455,"_1427":1428},"content",{"_1456":1457},"application/json",{"_1429":1458},{"_15":1459,"_1460":1461,"_1427":1465},"object","properties",{"_1462":1463},"secret",{"_21":1464,"_15":1438},"

The value of the shared secret key.

\n",[1462],"responses",{"_1468":1469,"_1483":1484,"_1498":1499},"201",{"_21":1470,"_1454":1471},"

successful creation

\n",{"_1456":1472},{"_1429":1473},{"_21":1474,"_15":1459,"_1460":1475,"_1427":1482},"

A view of a shared secret key assigned to a webhook receiver.

Once a secret is created, the value of the secret is not available in the API, as it must remain secret. Instead, secrets are referenced by their unique IDs assigned when they are created.

\n",{"_1434":1476,"_1478":1479},{"_21":1477,"_15":1438,"_1439":1440},"

The public unique ID of the secret.

\n","time_created",{"_21":1480,"_15":1438,"_1439":1481},"

The UTC timestamp at which this secret was created.

\n","date-time",[1434,1478],"4XX",{"_21":1485,"_1454":1486},"

Error

\n",{"_1456":1487},{"_1429":1488},{"_21":1489,"_15":1459,"_1460":1490,"_1427":1497},"

Error information from a response.

\n",{"_1491":1492,"_1493":1494,"_1495":1496},"error_code",{"_15":1438},"message",{"_15":1438},"request_id",{"_15":1438},[1493,1495],"5XX",{"_21":1485,"_1454":1500},{"_1456":1501},{"_1429":1502},{"_21":1489,"_15":1459,"_1460":1503,"_1427":1507},{"_1491":1504,"_1493":1505,"_1495":1506},{"_15":1438},{"_15":1438},{"_15":1438},[1493,1495],"actionData","errors"]

webhook_secrets_add

Query Parameters

1 id

2 name

Request Body

Responses

201successful creation

4XXError

5XXError