How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

UpCloud Permission API

Manage permissions for sub-accounts to access resources owned by the main account.

UpCloud Permission API is one of 29 APIs that UpCloud publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Permission. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 5 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 1.3.

Requests are made against a single base URL, https://api.upcloud.com.

6 operations 5 paths 7 schemas 1 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.3
Base URL
https://api.upcloud.com
Authentication
HTTP Bearer
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 1

UpCloud Permission API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (apiToken). By default, every request must be authenticated.

  • apiToken — UpCloud API uses HTTP Bearer authentication. An API token is required to authenticate. The API token can be created in the UpCloud control panel. Alternatively…

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 1 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Permission 6

Manage permissions for sub-accounts to access resources owned by the main account.

GET
/1.3/permission
List permissions
listPermissions → 200default
PUT
/1.3/permission
Replace permissions
replacePermissions body → 200default
POST
/1.3/permission/grant
Grant permission
grantPermission 1 param body → 200default
POST
/1.3/permission/revoke
Revoke permission
revokePermission body → 204default
POST
/1.3/permission/revoke-all-from-target/{target_type}/{target_identifier}
Revoke all permissions by target
revokeAllPermissionsByTarget 3 params → 204default
POST
/1.3/permission/revoke-all-from-user/{user}
Revoke all permissions by user
revokeAllPermissionsByUser 1 param → 204default

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are permissionDocument (4 properties), permissionError (1 property), permission (1 property), permissions (1 property). Each schema is shown below with its type and property counts.

permissionTargetType
Type of the target to grant permission to
permissions
object
List of permissions.
1 property 1 required
permissionTargetIdentifier
string
Target identifying string. This is type specific and in most cases is a UUID4. Wildcard value "" can be used to reference all target resources.
permissionDocument
object
Permission document defining access rights for a sub-account to a specific resource.
4 properties 3 required
permission
object
A single permission object.
1 property
permissionUserName
string
Username for an account.
permissionError
object
A general error response indicating that the request could not be fulfilled due to a technical issue.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

upcloud-permission-api-openapi.yml Raw ↑

Other APIs UpCloud publishes across the network.

UpCloud Account API
UpCloud Account Tokens API
UpCloud Audit Logs API
UpCloud Currency API
UpCloud Database API
UpCloud Device API
UpCloud Events API
UpCloud File Storage API
UpCloud Firewall Ruleset API
UpCloud Gateway API
UpCloud Ip Address API
UpCloud Kubernetes API
Where this information came from

This is an independent, third-party profile of UpCloud Permission API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.