STACKIT

STACKIT Resource Manager API

API v2 to manage resource containers - organizations, folders, projects incl. labels Resource Management STACKIT resource management handles the terms…

Developer tools#openapi

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

API v2 to manage resource containers - organizations, folders, projects incl. labels

Resource Management

STACKIT resource management handles the terms _Organization_, _Folder_, _Project_, _Label_, and the hierarchical structure between them. Technically, organizations,
folders, and projects are _Resource Containers_ to which a _Label_ can be attached to. The STACKIT _Resource Manager_ provides CRUD endpoints to query and to modify the state.

Organizations

STACKIT organizations are the base element to create and to use cloud-resources. An organization is bound to one customer account. Organizations have a lifecycle.

  • Organizations are always the root node in resource hierarchy and do not have a parent

Projects

STACKIT projects are needed to use cloud-resources. Projects serve as wrapper for underlying technical structures and processes. Projects have a lifecycle. Projects compared to folders may have different policies.

  • Projects are optional, but mandatory for cloud-resource usage
  • A project can be created having either an organization, or a folder as parent
  • A project must not have a project as parent
  • Project names under the same parent must not be unique
  • Root organization cannot be changed

Label

STACKIT labels are key-value pairs including a resource container reference. Labels can be defined and attached freely to resource containers by which resources can be organized and queried.

  • Policy-based, immutable labels may exists

Endpoints 16

  • GETGet All Folders/v2/foldersReturns all folders and their metadata that: Are children of the specific containerParentId Match the given containerIds User is member of <br /> Filter:…
  • POSTCreate Folder/v2/foldersCreates a new folder within a parent organization or folder. Authorization & Permissions: Evaluated on Target Parent Container: resource-manager.folder.create…
  • GETGet Folder Details/v2/folders/:containerIdReturns metadata for a specific folder. Authorization & Permissions: Evaluated on Target Folder: resource-manager.folder.get (required primary permission to…
  • DELETEDelete Folder/v2/folders/:containerIdDelete a folder and its metadata. Folder must not contain active child containers unless force deletion is enabled without attached projects. Authorization &…
  • PATCHUpdate Folder/v2/folders/:containerIdUpdate the folder and its metadata (name, labels, parent container). Authorization & Permissions: Evaluated on Target Folder: resource-manager.folder.edit…
  • DELETEDelete Folder Labels/v2/folders/:containerId/labelsDeletes folder labels by specified keys, or removes all labels if no key is provided. Authorization & Permissions: Evaluated on Target Folder:…
  • GETGet all organizations of member/v2/organizationsReturns all organizations and their metadata accessible to the caller. Filterable by containerIds or member. Authorization & Permissions: Evaluated on Target…
  • DELETEDelete Organization Labels/v2/organizations/:containerId/labelsDeletes organization labels by specified keys, or removes all labels if no key is provided. Authorization & Permissions: Evaluated on Target Organization:…
  • GETGet Organization Details/v2/organizations/:idReturns metadata for a specific organization. Authorization & Permissions: Evaluated on Target Organization: resource-manager.organization.get (required…
  • PATCHUpdate Organization/v2/organizations/:idUpdates organization metadata (name, labels). Authorization & Permissions: Evaluated on Target Organization: resource-manager.organization.edit (required…
  • GETGet All Projects of a member./v2/projectsReturns all projects and their metadata that: Are children of the specific containerParentId Match the given containerIds User is member of Filter: Either…
  • POSTCreate Project/v2/projectsCreates a new project within a parent container. Creation request returns synchronously, while underlying resource provisioning runs asynchronously. Initial…
  • DELETEDelete Project Labels/v2/projects/:containerId/labelsDeletes project labels by specified keys, or removes all labels if no key is provided. Authorization & Permissions: Evaluated on Target Project:…
  • GETGet Project Details/v2/projects/:idReturns the project and its metadata. Authorization & Permissions: Evaluated on Target Project: resource-manager.project.get (required primary permission to…
  • DELETEDelete Project/v2/projects/:idTriggers the deletion of a project. Request returns synchronously, while deletion process runs asynchronously. Initial lifecycle state is DELETING until…
  • PATCHUpdate Project/v2/projects/:idUpdates project metadata (name, labels, or parent hierarchy). Authorization & Permissions: Evaluated on Target Project: resource-manager.project.edit…

API details

Base URL
https://resource-manager.api.stackit.cloud
Authentication
None declared in the description
Operations
16 operations on 9 pathsGET 6DELETE 5PATCH 3POST 2
Response formats
application/json
Description format
OpenAPI 3.0.3, API version 2.0

How to test the STACKIT Resource Manager API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the STACKIT Resource Manager API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Get All Folders” (GET /v2/folders), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the STACKIT Resource Manager API?

API v2 to manage resource containers - organizations, folders, projects incl. labels Resource Management STACKIT resource management handles the terms… It is listed under Developer tools and has 16 endpoints.

Who publishes the STACKIT Resource Manager 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 Resource Manager API?

Requests go to https://resource-manager.api.stackit.cloud. Endpoint paths are added to this base URL.

How do I authenticate with the STACKIT Resource Manager 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 Resource Manager API have?

16 operations on 9 paths (6 GET, 5 DELETE, 3 PATCH, 2 POST).

Is forking the STACKIT Resource Manager API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.