STACKIT IaaS API
This API allows you to create and modify IaaS resources.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This API allows you to create and modify IaaS resources.
Endpoints 136
- GETList all SSH keypairs for the requesting user.
/v2/keypairsGet a list of all SSH keypairs assigned to the requesting user. - POSTImport a public key.
/v2/keypairsImport a new public key for the requesting user based on provided public key material. The creation will fail if an SSH keypair with the same name already… - GETGet SSH keypair details.
/v2/keypairs/:keypairNameGet details about an SSH keypair. - DELETEDelete an SSH keypair.
/v2/keypairs/:keypairNameDelete an SSH keypair from a user. - PATCHUpdate information of an SSH keypair.
/v2/keypairs/:keypairNameUpdate labels of the SSH keypair. - GETList all public IP ranges.
/v2/networks/public-ip-rangesGet a list of all public IP ranges that STACKIT uses. - GETList all network areas in an organization.
/v2/organizations/:organizationId/network-areasGet a list of all visible network areas defined in an organization. - POSTCreate new network area in an organization.
/v2/organizations/:organizationId/network-areasCreate a new network area in an organization. You can specify "preview/routingtables"="true" as a label to enable the preview routing tables feature. This… - GETGet details about a network area.
/v2/organizations/:organizationId/network-areas/:areaIdGet details about a network area in an organization. - DELETEDelete a network area.
/v2/organizations/:organizationId/network-areas/:areaIdDelete an existing network area in an organization. This is only possible if no projects are using the area anymore. - PATCHUpdate network area settings.
/v2/organizations/:organizationId/network-areas/:areaIdUpdate the settings of a network area in an organization. - GETList all projects using a network area.
/v2/organizations/:organizationId/network-areas/:areaId/projectsGet a list of all projects using a network area. - GETList all configured regions in a network area.
/v2/organizations/:organizationId/network-areas/:areaId/regionsGet a list of all configured regions. - GETGet details about a configured region.
/v2/organizations/:organizationId/network-areas/:areaId/regions/:regionGet details about a configured region in a network area. - PUTConfigure a region for a network area.
/v2/organizations/:organizationId/network-areas/:areaId/regions/:regionConfigure a new region for a network area. - DELETEDelete a configuration of region for a network area.
/v2/organizations/:organizationId/network-areas/:areaId/regions/:regionDelete a current configuration of region for a network area. - PATCHUpdate a region for a network area.
/v2/organizations/:organizationId/network-areas/:areaId/regions/:regionUpdate a new region for a network area. - GETList all network ranges in a network area.
/v2/organizations/:organizationId/network-areas/:areaId/regions/:region/network-rangesGet a list of all network ranges in a network area. - POSTCreate new network range in a network area.
/v2/organizations/:organizationId/network-areas/:areaId/regions/:region/network-rangesCreate a new network range in an existing network area. - GETGet details about a network range.
/v2/organizations/:organizationId/network-areas/:areaId/regions/:region/network-ranges/:networkRangeIdGet details about a network range in a network area. - DELETEDelete a network range.
/v2/organizations/:organizationId/network-areas/:areaId/regions/:region/network-ranges/:networkRangeIdDelete a network range of a network area. The deletion will fail if the network range is still used. - GETList all network routes in a network area.
/v2/organizations/:organizationId/network-areas/:areaId/regions/:region/routesGet a list of all network routes defined in a network area. - POSTCreate new network routes.
/v2/organizations/:organizationId/network-areas/:areaId/regions/:region/routesCreate one or several new network routes in a network area. - GETGet details about a network route.
/v2/organizations/:organizationId/network-areas/:areaId/regions/:region/routes/:routeIdGet details about a network route defined in a network area. - DELETEDelete a network route.
/v2/organizations/:organizationId/network-areas/:areaId/regions/:region/routes/:routeIdDelete a network route of a network area. - PATCHUpdate a network route.
/v2/organizations/:organizationId/network-areas/:areaId/regions/:region/routes/:routeIdUpdate a network route defined in a network area. - GETList all routing tables in a network area.
/v2/organizations/:organizationId/network-areas/:areaId/regions/:region/routing-tablesGet a list of all routing tables in a network area. - POSTCreate new routing table in a network area.
/v2/organizations/:organizationId/network-areas/:areaId/regions/:region/routing-tablesCreate a new routing table in an existing network area. - GETGet details about a routing table.
/v2/organizations/:organizationId/network-areas/:areaId/regions/:region/routing-tables/:routingTableIdGet details about a routing table defined in a network area. - DELETEDelete a routing table.
/v2/organizations/:organizationId/network-areas/:areaId/regions/:region/routing-tables/:routingTableIdDelete a routing table of a network area. - PATCHUpdate a routing table.
/v2/organizations/:organizationId/network-areas/:areaId/regions/:region/routing-tables/:routingTableIdUpdate a routing table defined in a network area. - GETList all routes in a routing table.
/v2/organizations/:organizationId/network-areas/:areaId/regions/:region/routing-tables/:routingTableId/routesGet a list of all routes in a routing table. - POSTCreate new routes in a routing table.
/v2/organizations/:organizationId/network-areas/:areaId/regions/:region/routing-tables/:routingTableId/routesCreate new routes in an existing routing table. - GETGet details about a route of a routing table.
/v2/organizations/:organizationId/network-areas/:areaId/regions/:region/routing-tables/:routingTableId/routes/:routeIdGet details about a route defined in a routing table. - DELETEDelete a route in a routing table.
/v2/organizations/:organizationId/network-areas/:areaId/regions/:region/routing-tables/:routingTableId/routes/:routeIdDelete a route in an existing routing table. - PATCHUpdate a route of a routing table.
/v2/organizations/:organizationId/network-areas/:areaId/regions/:region/routing-tables/:routingTableId/routes/:routeIdUpdate a route defined in a routing table. - GETLookup an organization request ID.
/v2/organizations/:organizationId/requests/:requestIdLookup an organization request ID from a previous request. This allows to find resource IDs of resources generated during a organization request. - GETGet project details.
/v2/projects/:projectIdGet details about a STACKIT project. - GETGet the affinity groups setup for a project.
/v2/projects/:projectId/regions/:region/affinity-groupsGet the affinity groups created in a project. Affinity groups are an indication of locality of a server relative to another group of servers. They can be… - POSTCreate a new affinity group in a project.
/v2/projects/:projectId/regions/:region/affinity-groupsCreate a new server affinity group in the given project ID. - GETGet the affinity group.
/v2/projects/:projectId/regions/:region/affinity-groups/:affinityGroupIdGet the affinity group created in a project. - DELETEDelete a affinity group in a project.
/v2/projects/:projectId/regions/:region/affinity-groups/:affinityGroupIdDelete a affinity group in the given project. - GETList all backups inside a project.
/v2/projects/:projectId/regions/:region/backupsGet a list of all backups inside a project. - POSTCreate new Backup.
/v2/projects/:projectId/regions/:region/backupsCreate a new Backup in a project. If a snapshot ID is provided create the backup from the snapshot. - GETGet details about a backup.
/v2/projects/:projectId/regions/:region/backups/:backupIdGet details about a block device backup. - DELETEDelete a backup.
/v2/projects/:projectId/regions/:region/backups/:backupIdDelete a backup that is part of the project. - PATCHUpdate information of a backup.
/v2/projects/:projectId/regions/:region/backups/:backupIdUpdate name or labels of the backup. - POSTRestore Backup to the referenced source Volume.
/v2/projects/:projectId/regions/:region/backups/:backupId/restoreRestores a Backup to the existing Volume it references to. The use of this endpoint is disruptive as the volume needs to be detached. If a new volume is to be… - GETList all Images inside a project.
/v2/projects/:projectId/regions/:region/imagesGet a list of all images inside a project. - POSTCreate new Image.
/v2/projects/:projectId/regions/:region/imagesCreate a new Image in a project in queued state. Image data must be imported separately. This call returns a pre-signed URL to upload small images. - GETGet details about an image.
/v2/projects/:projectId/regions/:region/images/:imageIdGet details about a specific Image inside a project. - DELETEDelete an Image.
/v2/projects/:projectId/regions/:region/images/:imageIdDelete an image that is part of the project. - PATCHUpdate Image Parameters.
/v2/projects/:projectId/regions/:region/images/:imageIdUpdate the properties of an existing Image inside a project. - GETGet share details of an image.
/v2/projects/:projectId/regions/:region/images/:imageId/shareGet share details about an shared image. - PUTSet image share.
/v2/projects/:projectId/regions/:region/images/:imageId/shareSet share of an Image. New Options will replace existing settings. - DELETERemove image share.
/v2/projects/:projectId/regions/:region/images/:imageId/shareRemove the image share. New scope will be local. - PATCHUpdate image share.
/v2/projects/:projectId/regions/:region/images/:imageId/shareUpdate share of an Image. Projects will be appended to existing list. - GETGet image share consumer.
/v2/projects/:projectId/regions/:region/images/:imageId/share/:consumerProjectIdGet details about an image share consumer. - DELETERemove an image share consumer.
/v2/projects/:projectId/regions/:region/images/:imageId/share/:consumerProjectIdRemove consumer from a shared image. - POSTCreate a single isolated network.
/v2/projects/:projectId/regions/:region/isolated-networkCreates an isolated network which is not connected to other networks in this project. We recommend using this endpoint only if you are fully aware of its… - GETList all machine types available for a project.
/v2/projects/:projectId/regions/:region/machine-typesGet a list of all machine type available in a project. - GETGet details about a machine type.
/v2/projects/:projectId/regions/:region/machine-types/:machineTypeGet details about a specific machine type. - GETList all networks inside a project.
/v2/projects/:projectId/regions/:region/networksGet a list of all networks inside a project. - POSTCreate new network.
/v2/projects/:projectId/regions/:region/networksCreate a new network in a project. nameservers will be filled from defaultNameservers of the respective area if not specified. If the project has… - GETGet network details.
/v2/projects/:projectId/regions/:region/networks/:networkIdGet details about a network of a project. - DELETEDelete network.
/v2/projects/:projectId/regions/:region/networks/:networkIdDelete a network. If the network is still in use, the deletion will fail. - PATCHUpdate network settings.
/v2/projects/:projectId/regions/:region/networks/:networkIdUpdate the settings of a network inside a project. - GETList all network interfaces inside a network.
/v2/projects/:projectId/regions/:region/networks/:networkId/nicsGet a list of all network interfaces inside a network. - POSTCreate new network interface.
/v2/projects/:projectId/regions/:region/networks/:networkId/nicsCreate a new network interface in a project. - GETGet details about a network interface.
/v2/projects/:projectId/regions/:region/networks/:networkId/nics/:nicIdGet details about a network interface inside a network. - DELETEDelete a network interface.
/v2/projects/:projectId/regions/:region/networks/:networkId/nics/:nicIdDelete a network interface that is part of the project. - PATCHUpdate a network interface.
/v2/projects/:projectId/regions/:region/networks/:networkId/nics/:nicIdUpdate the properties of an existing network interface inside a network. - GETList all network interfaces inside a project.
/v2/projects/:projectId/regions/:region/nicsGet a list of all network interfaces inside a project. - GETGet details about a network interface of a project.
/v2/projects/:projectId/regions/:region/nics/:nicIdGet details about a network interface inside a project. - GETList all public IPs inside a project.
/v2/projects/:projectId/regions/:region/public-ipsGet a list of all public IPs inside a project. - POSTCreate new public IP.
/v2/projects/:projectId/regions/:region/public-ipsCreate a new public IP in a project. - GETGet details about a public IP.
/v2/projects/:projectId/regions/:region/public-ips/:publicIpIdGet details about a public IP inside a project. - DELETEDelete a public IP.
/v2/projects/:projectId/regions/:region/public-ips/:publicIpIdDelete a public IP that is part of the project. - PATCHUpdate a public IP.
/v2/projects/:projectId/regions/:region/public-ips/:publicIpIdUpdate the properties of an existing public IP inside a project. - GETList project quotas.
/v2/projects/:projectId/regions/:region/quotasList quota limits and usage for project resources. - GETLookup a project request ID.
/v2/projects/:projectId/regions/:region/requests/:requestIdLookup a project request ID from a previous request. This allows to find resource IDs of resources generated during a projects request. - GETList all security groups inside a project.
/v2/projects/:projectId/regions/:region/security-groupsGet a list of all security groups inside a project. - POSTCreate new security group.
/v2/projects/:projectId/regions/:region/security-groupsCreate a new security group in a project. - GETGet security group details.
/v2/projects/:projectId/regions/:region/security-groups/:securityGroupIdGet details about a security group of a project. - DELETEDelete security group.
/v2/projects/:projectId/regions/:region/security-groups/:securityGroupIdDelete a security group. - PATCHUpdate information of a security group.
/v2/projects/:projectId/regions/:region/security-groups/:securityGroupIdUpdate labels of the security group. - GETList all rules for a security group.
/v2/projects/:projectId/regions/:region/security-groups/:securityGroupId/rulesGet a list of all rules inside a security group. - POSTCreate new security group rule.
/v2/projects/:projectId/regions/:region/security-groups/:securityGroupId/rulesCreate a new security group rule in a project. - GETGet security group rule details.
/v2/projects/:projectId/regions/:region/security-groups/:securityGroupId/rules/:securityGroupRuleIdGet details about a security group rule of a project. - DELETEDelete security group rule.
/v2/projects/:projectId/regions/:region/security-groups/:securityGroupId/rules/:securityGroupRuleIdDelete a security group rule. - GETList all servers inside a project.
/v2/projects/:projectId/regions/:region/serversGet a list of all servers inside a project. - POSTCreate new server.
/v2/projects/:projectId/regions/:region/serversCreate a new server in a project. - GETGet server details.
/v2/projects/:projectId/regions/:region/servers/:serverIdGet details about a server by its ID. - DELETEDelete a server.
/v2/projects/:projectId/regions/:region/servers/:serverIdDelete a server. Volumes won't be deleted. - PATCHUpdate information of a server.
/v2/projects/:projectId/regions/:region/servers/:serverIdUpdate name or labels of the server. - GETGet server console.
/v2/projects/:projectId/regions/:region/servers/:serverId/consoleGet a URL for server remote console. - POSTDeallocate an existing server.
/v2/projects/:projectId/regions/:region/servers/:serverId/deallocateDeallocate an existing server. The server will be removed from the hypervisor so only the volume will be billed. - GETGet server log.
/v2/projects/:projectId/regions/:region/servers/:serverId/logGet server console log. - POSTCreate and attach a network interface from the specified network.
/v2/projects/:projectId/regions/:region/servers/:serverId/networks/:networkIdCreate and attach a network interface from the specified network to the server. - DELETEDetach and delete all network interfaces associated with the specified network.
/v2/projects/:projectId/regions/:region/servers/:serverId/networks/:networkIdDetach and delete all network interfaces associated with the specified network from the server. - GETGet all network interfaces.
/v2/projects/:projectId/regions/:region/servers/:serverId/nicsGet all network interfaces attached to the server. - PUTAttach an existing network interface.
/v2/projects/:projectId/regions/:region/servers/:serverId/nics/:nicIdAttach an existing network interface to a server. - DELETEDetach a network interface.
/v2/projects/:projectId/regions/:region/servers/:serverId/nics/:nicIdDetach a network interface from a server. - PUTAssociate a public IP to the server.
/v2/projects/:projectId/regions/:region/servers/:serverId/public-ips/:publicIpIdAssociate a public IP to a server. - DELETEDissociate a public IP from a server.
/v2/projects/:projectId/regions/:region/servers/:serverId/public-ips/:publicIpIdDissociate a public IP on an existing server. - POSTReboot the server.
/v2/projects/:projectId/regions/:region/servers/:serverId/rebootReboot the server. A soft reboot will attempt to gracefully shut down the server by passing the command to the operating system. A hard reboot will power… - POSTRescue an existing server.
/v2/projects/:projectId/regions/:region/servers/:serverId/rescueRescue an existing server. It is shutdown and the initial image is attached as the boot volume, while the boot volume is attached as secondary volume and the… - POSTResize a server.
/v2/projects/:projectId/regions/:region/servers/:serverId/resizeResize the server to the given machine type. - PUTAdd a server to a security group.
/v2/projects/:projectId/regions/:region/servers/:serverId/security-groups/:securityGroupIdAdd an existing server to an existing security group. - DELETERemove a server from a security group.
/v2/projects/:projectId/regions/:region/servers/:serverId/security-groups/:securityGroupIdRemove a server from a attached security group. - GETList the service account of the Server.
/v2/projects/:projectId/regions/:region/servers/:serverId/service-accountsGet service account of the server in a list. - PUTAttach service account to a server.
/v2/projects/:projectId/regions/:region/servers/:serverId/service-accounts/:serviceAccountMailAttach a service account to the server. - DELETEDetach a service account from a server.
/v2/projects/:projectId/regions/:region/servers/:serverId/service-accounts/:serviceAccountMailDetach a service account from the server. - POSTBoot up a server.
/v2/projects/:projectId/regions/:region/servers/:serverId/startStart an existing server or allocates the server if deallocated. - POSTStop an existing server.
/v2/projects/:projectId/regions/:region/servers/:serverId/stopStops an existing server. The server will remain on the Hypervisor and will be charged full price for all resources attached to it. The attached resources… - POSTUnrescue an existing server.
/v2/projects/:projectId/regions/:region/servers/:serverId/unrescueUnrescue an existing server. The original boot volume is attached as boot volume of the server and the server is booted up. - GETList all volume attachments of a server.
/v2/projects/:projectId/regions/:region/servers/:serverId/volume-attachmentsGet a list of all volume attachments of a server. - GETGet Volume Attachment details.
/v2/projects/:projectId/regions/:region/servers/:serverId/volume-attachments/:volumeIdGet the details of an existing Volume Attachment. - PUTAttach a volume to a server.
/v2/projects/:projectId/regions/:region/servers/:serverId/volume-attachments/:volumeIdAttach an existing volume to an existing server. - DELETEDetach a volume from a server.
/v2/projects/:projectId/regions/:region/servers/:serverId/volume-attachments/:volumeIdDetach an existing volume from an existing server. - PATCHUpdate Volume Attachment Parameters.
/v2/projects/:projectId/regions/:region/servers/:serverId/volume-attachments/:volumeIdUpdate the properties of an existing Volume Attachment. - GETList all snapshots inside a project.
/v2/projects/:projectId/regions/:region/snapshotsGet a list of all snapshots inside a project. - POSTCreate new Snapshot.
/v2/projects/:projectId/regions/:region/snapshotsCreate a new Snapshot from a Volume in a project. - GETGet details about a snapshot.
/v2/projects/:projectId/regions/:region/snapshots/:snapshotIdGet details about a block device snapshot. - DELETEDelete a snapshot.
/v2/projects/:projectId/regions/:region/snapshots/:snapshotIdDelete a snapshot that is part of the project. - PATCHUpdate information of the snapshot.
/v2/projects/:projectId/regions/:region/snapshots/:snapshotIdUpdate information like name or labels of the snapshot. - GETList all volume performance classes available for a project.
/v2/projects/:projectId/regions/:region/volume-performance-classesGet a list of all volume performance classes available inside a project. - GETGet details about a volume performance class.
/v2/projects/:projectId/regions/:region/volume-performance-classes/:volumePerformanceClassGet details about a specific volume performance class. - GETList all volumes inside a project.
/v2/projects/:projectId/regions/:region/volumesGet a list of all volumes inside a project. - POSTCreate new volume.
/v2/projects/:projectId/regions/:region/volumesCreate a new volume in a project. If a volume source is not provided, an empty volume will be created. The size property is required if no source or an image… - GETGet details about a volume.
/v2/projects/:projectId/regions/:region/volumes/:volumeIdGet details about a block device volume. - DELETEDelete a volume.
/v2/projects/:projectId/regions/:region/volumes/:volumeIdDelete a volume inside a project. The deletion will fail if the volume is still in use. - PATCHUpdate information of a volume.
/v2/projects/:projectId/regions/:region/volumes/:volumeIdUpdate name, description or labels of the volume. - POSTUpdate the size of a volume.
/v2/projects/:projectId/regions/:region/volumes/:volumeId/resizeUpdate the size of a block device volume. The new volume size must be larger than the current size. - POSTCreate an image out of a volume.
/v2/projects/:projectId/regions/:region/volumes/:volumeId/uploadCreate an image out a a volume. - GETList all availability zones.
/v2/regions/:region/availability-zonesGet a list of all availability zones.
API details
- Base URL
https://iaas.api.stackit.cloud- Authentication
- None declared in the description
- Operations
- 136 operations on 73 pathsGET 57POST 29DELETE 26PATCH 17PUT 7
- Response formats
application/json- Description format
- OpenAPI 3.0.1, API version
2 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- STACKIT's published OpenAPI description (stackitcloud/stackit-api-specifications) (Apache-2.0)
How to test the STACKIT IaaS API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the STACKIT IaaS API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “List all SSH keypairs for the requesting user.” (GET /v2/keypairs), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the STACKIT IaaS API?
This API allows you to create and modify IaaS resources. It is listed under Developer tools and has 136 endpoints.
Who publishes the STACKIT IaaS API?
It is listed from STACKIT's public API description (an OpenAPI document), not published by STACKIT on Swastik Codes. Anyone who controls stackit.cloud can claim the profile by adding a DNS TXT record.
What is the base URL of the STACKIT IaaS API?
Requests go to https://iaas.api.stackit.cloud. Endpoint paths are added to this base URL.
How do I authenticate with the STACKIT IaaS API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the STACKIT IaaS API have?
136 operations on 73 paths (57 GET, 29 POST, 26 DELETE, 17 PATCH, 7 PUT).
Is forking the STACKIT IaaS API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.