actionPOSTv1.0.0
accounts_create
Create a new account.
actionDELETEv1.0.0
accounts_destroy
Accounts can be deleted, when all services and configs are decommissioned or the account is not longer referenced e.g. as a `managing_account` or `billing_account`. Deleting an account will cascade to `contacts` and `role-assignments`. The request will immediately fail, if the above preconditions are not met.
actionGETv1.0.0
accounts_list
Retrieve a list of `Account`s. This includes all accounts the currently authorized account is managing and the current account itself.
actionPATCHv1.0.0
accounts_partial_update
Update parts of an account.
actionGETv1.0.0
accounts_read
Get a single account.
actionPUTv1.0.0
accounts_update
Update the entire account.
actionGETv1.0.0
api_implementation_read
Get the API implementation details.
actionGETv1.0.0
connections_list
List all `connection`s.
actionGETv1.0.0
connections_read
Read a `connection`.
actionPOSTv1.0.0
contacts_create
Create a new contact.
actionDELETEv1.0.0
contacts_destroy
Remove a contact. Please note, that a contact can only be removed if it is not longer in use in a network service or config through a role assignment.
actionGETv1.0.0
contacts_list
List available contacts managed by the authorized account.
actionPATCHv1.0.0
contacts_partial_update
Update parts of a contact
actionGETv1.0.0
contacts_read
Get a contact by it's id
actionPUTv1.0.0
contacts_update
Update a contact
actionGETv1.0.0
devices_list
List available devices
actionGETv1.0.0
devices_read
Get a specific device identified by id
actionGETv1.0.0
facilities_list
Get a (filtered) list of `facilities`.
actionGETv1.0.0
facilities_read
Retrieve a facility by id
actionPOSTv1.0.0
ips_create
Add an ip host address or network prefix.
actionGETv1.0.0
ips_list
List all ip addresses (and prefixes).
actionPATCHv1.0.0
ips_partial_update
Update parts of an ip address. As with the `PUT` opertaion, IP addresses, where you don't have update rights, will yield a `resource access denied` error when attempting an update. If the ip address was allocated for you, you might not be able to change anything but the `fqdn`.
actionGETv1.0.0
ips_read
Get a single ip addresses by it's id.
actionPUTv1.0.0
ips_update
Update an ip address object. You can only update IP addresses within your current scope. Not all addresses you can read you can update. If the ip address was allocated for you, you might not be able to change anything but the `fqdn`.
actionPOSTv1.0.0
macs_create
Register a mac address.
actionDELETEv1.0.0
macs_destroy
Remove a mac address.
actionGETv1.0.0
macs_list
List all mac addresses managed by the authorized customer.
actionGETv1.0.0
macs_read
Get a single mac address by it's id.
actionPOSTv1.0.0
member_joining_rules_create
Create a member joining rule
actionDELETEv1.0.0
member_joining_rules_destroy
Delete a joining rule
actionGETv1.0.0
member_joining_rules_list
Get a list of joining rules
actionPATCHv1.0.0
member_joining_rules_partial_update
Partially update a joining rule
actionGETv1.0.0
member_joining_rules_read
Get a single rule
actionPUTv1.0.0
member_joining_rules_update
Update a joining rule
actionGETv1.0.0
metro_area_networks_list
List all MetroAreaNetworks
actionGETv1.0.0
metro_area_networks_read
Retrieve a MetroAreaNetwork
actionGETv1.0.0
metro_areas_list
List all MetroAreas
actionGETv1.0.0
metro_areas_read
Get a single MetroArea
actionPOSTv1.0.0
network_feature_configs_create
Create a configuration for a `NetworkFeature` defined in the `NetworkFeature`s collection.
actionDELETEv1.0.0
network_feature_configs_destroy
Remove a network feature config. The network feature config will be marked as `decommission_requested`. Decommissioning a network feature config will not cascade to related services or service configs.
actionGETv1.0.0
network_feature_configs_list
Get all network feature configs.
actionPATCHv1.0.0
network_feature_configs_partial_update
Update parts of a network feature configuration
actionGETv1.0.0
network_feature_configs_read
Get a single network feature config.
actionPUTv1.0.0
network_feature_configs_update
Update a network feature configuration
actionGETv1.0.0
network_features_list
List available network features.
actionGETv1.0.0
network_features_read
Get a single network feature by it's id.
actionGETv1.0.0
network_service_cancellation_policy_read
The cancellation-policy can be queried to answer the questions: If I cancel my service, *when will it be technically decommissioned*? If I cancel my service, *until what date will I be charged*? When the query parameter `decommision_at` is not provided it will provide the first possible cancellation date and charge period if cancelled at above date. The granularity of the date field is a day, the start and end of which are to be interpreted by the IXP (some may use UTC, some may use their local time zone).
actionDELETEv1.0.0
network_service_change_request_destroy
Retract or reject a change to the network service.
actionGETv1.0.0
network_service_change_request_read
Get the change request.
actionGETv1.0.0
network_service_config_cancellation_policy_read
The cancellation-policy can be queried to answer the questions: If I cancel my subscription, *when will it be technically decommissioned*? If I cancel my subscription, *until what date will I be charged*? When the query parameter `decommision_at` is not provided it will provide the first possible cancellation date and charge period if cancelled at above date. The granularity of the date field is a day, the start and end of which are to be interpreted by the IXP (some may use UTC, some may use their local time zone).
actionPOSTv1.0.0
network_service_configs_create
Create a `network-service-config`.
actionDELETEv1.0.0
network_service_configs_destroy
Request decommissioning the network service configuration. The network service config will assume the state `decommission_requested`. This will cascade to related resources like `network-feature-configs`.
actionGETv1.0.0
network_service_configs_list
Get all `network-service-config`s.
actionPATCHv1.0.0
network_service_configs_partial_update
Update parts of an exisiting `network-service-config`.
actionGETv1.0.0
network_service_configs_read
Get a `network-service-config`
actionPUTv1.0.0
network_service_configs_update
Update an exisiting `network-service-config`
actionPOSTv1.0.0
network_services_create
Create a new network service
actionDELETEv1.0.0
network_services_destroy
Request decomissioning of the network service. The network service will enter the state of `decommission_requested`. The request will cascade to related network service and feature configs. An *optional request body* can be provided to request a specific service termination date. If no date is given in the request body, it is assumed to be the earliest possible date. Possible values for `decommission_at` can be queried through the `network_service_cancellation_policy_read` operation. The response will contain the dates on which the changes will be effected.
actionGETv1.0.0
network_services_list
List available `NetworkService`s.
actionPATCHv1.0.0
network_services_partial_update
Partially update a network service
actionGETv1.0.0
network_services_read
Get a specific `network-service` by id.
actionPUTv1.0.0
network_services_update
Update a network service
actionPOSTv1.0.0
network-service-change-request_create
Request a change to the network service. A participant in a network service of type `p2p_vc` can issue a change request, expressing a desired change in the capacity. The change is accepted when all sides have configured the network service configs with the new bandwidth. These changes can sometimes require a change of the product offering. The product offering may only differ in regards to bandwidth. The network service will change it's state from `production` into `production_change_pending`. Only one change request may be issued at a time.
actionGETv1.0.0
pops_list
List all PoPs
actionGETv1.0.0
pops_read
Get a single point of presence
actionGETv1.0.0
ports_list
List all ports.
actionGETv1.0.0
ports_read
Retrieve a port.
actionGETv1.0.0
product_offerings_list
List all (filtered) products-offerings available on the platform
actionGETv1.0.0
product_offerings_read
Get a single products-offering by id.
actionPOSTv1.0.0
role_assignments_create
Assign a `Role` to a `Contact`. The contact needs to have all fields filled, which the role requires. If this is not the case a `400` `UnableToFulfill` will be returned.
actionDELETEv1.0.0
role_assignments_destroy
Remove a role assignment from a contact. If the contact is still in use with a given role required, this will yield an `UnableToFulfill` error.
actionGETv1.0.0
role_assignments_list
List all role assignments for a contact.
actionGETv1.0.0
role_assignments_read
Get a role assignment for a contact.
actionGETv1.0.0
roles_list
List all roles available.
actionGETv1.0.0
roles_read
Get a single `Role`.
Beyond the catalog
Any provider, on request.
01
Request it
Tell us which provider you need, and we will ship it in the registry.
02
Generate it
Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.
acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec