Upsun Organization Management API
The Organization Management API from Upsun — 4 operation(s) for organization management.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/upsun-organization-management-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Upsun.com Rest Organization Management API
version: '1.0'
contact:
name: Support
url: https://upsun.com/contact-us/
termsOfService: https://upsun.com/trust-center/legal/tos/
description: '# Introduction
Upsun, formerly Platform.sh, is a container-based Platform-as-a-Service.'
x-logo:
url: https://docs.upsun.com/images/upsun-api.svg
href: https://upsun.com/#section/Introduction
altText: Upsun logo
servers:
- url: '{schemes}://api.upsun.com'
description: The Upsun.com API gateway
variables:
schemes:
default: https
security:
- OAuth2: []
tags:
- name: Organization Management
paths:
/organizations/{organization_id}/estimate:
get:
summary: Estimate total spend
description: Estimates the total spend for the specified organization.
operationId: estimate-org
tags:
- Organization Management
parameters:
- $ref: '#/components/parameters/OrganizationIDName'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationEstimationObject'
'403':
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
x-vendor: upsun
/organizations/{organization_id}/alerts/billing:
get:
summary: Get billing alert configuration
description: Retrieves billing alert configuration for the specified organization.
operationId: get-org-billing-alert-config
tags:
- Organization Management
parameters:
- $ref: '#/components/parameters/OrganizationIDName'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationAlertConfig'
'403':
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
x-vendor: upsun
patch:
summary: Update billing alert configuration
description: Updates billing alert configuration for the specified organization.
operationId: update-org-billing-alert-config
tags:
- Organization Management
parameters:
- $ref: '#/components/parameters/OrganizationIDName'
requestBody:
content:
application/json:
schema:
type: object
properties:
active:
type: boolean
description: Whether the billing alert should be active or not.
config:
type: object
description: The configuration for billing alerts.
properties:
threshold:
type: integer
description: The amount after which a billing alert should be triggered.
mode:
type: string
description: The mode in which the alert is triggered.
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationAlertConfig'
'403':
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
x-vendor: upsun
/organizations/{organization_id}/prepayment:
get:
summary: Get organization prepayment information
description: Retrieves prepayment information for the specified organization, if applicable.
operationId: get-org-prepayment-info
tags:
- Organization Management
parameters:
- $ref: '#/components/parameters/OrganizationID'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
prepayment:
$ref: '#/components/schemas/PrepaymentObject'
_links:
type: object
properties:
self:
type: object
description: Link to the current resource.
properties:
href:
type: string
description: URL of the link.
transactions:
type: object
description: Link to the prepayment transactions resource.
properties:
href:
type: string
description: URL of the link.
'403':
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
x-vendor: upsun
/organizations/{organization_id}/prepayment/transactions:
get:
summary: List organization prepayment transactions
description: Retrieves a list of prepayment transactions for the specified organization, if applicable.
operationId: list-org-prepayment-transactions
tags:
- Organization Management
parameters:
- $ref: '#/components/parameters/OrganizationID'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of items across pages.
transactions:
type: array
items:
$ref: '#/components/schemas/PrepaymentTransactionObject'
_links:
type: object
properties:
self:
type: object
description: Link to the current set of items.
properties:
href:
type: string
description: URL of the link.
previous:
type: object
description: Link to the previous set of items.
properties:
href:
type: string
description: URL of the link.
next:
type: object
description: Link to the next set of items.
properties:
href:
type: string
description: URL of the link
prepayment:
type: object
description: Link to the prepayment resource.
properties:
href:
type: string
description: URL of the link.
'403':
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
x-vendor: upsun
components:
parameters:
OrganizationIDName:
in: path
name: organization_id
description: 'The ID of the organization.<br>
Prefix with name= to retrieve the organization by name instead.
'
required: true
schema:
type: string
OrganizationID:
name: organization_id
in: path
required: true
description: The ID of the organization.
schema:
type: string
format: ulid
schemas:
PrepaymentObject:
type: object
description: Prepayment information for an organization.
properties:
prepayment:
type: object
description: Prepayment information for an organization.
properties:
organization_id:
type: string
description: Organization ID
balance:
type: object
description: The prepayment balance in complex format.
properties:
formatted:
type: string
description: Formatted balance.
amount:
type: number
description: The balance amount.
currency_code:
type: string
description: The balance currency code.
currency_symbol:
type: string
description: The balance currency symbol.
last_updated_at:
type:
- string
- 'null'
description: The date the prepayment balance was last updated.
sufficient:
type: boolean
description: Whether the prepayment balance is enough to cover the upcoming order.
fallback:
type:
- string
- 'null'
description: The fallback payment method, if any, to be used in case prepayment balance is not enough to cover an order.
Error:
description: ''
type: object
properties:
status:
type: string
message:
type: string
code:
type: number
detail:
type: object
title:
type: string
title: ''
x-examples:
example-1:
status: Invalid input
message: This field is required.
code: 400
detail:
field:
- This field is required.
title: Bad Request
PrepaymentTransactionObject:
type: object
description: Prepayment transaction for an organization.
properties:
order_id:
type: string
description: Order ID
message:
type: string
description: The message associated with transaction.
status:
type: string
description: Whether the transactions was successful or a failure.
amount:
type: object
description: The prepayment balance in complex format.
properties:
formatted:
type: string
description: Formatted balance.
amount:
type: number
description: The balance amount.
currency_code:
type: string
description: The balance currency code.
currency_symbol:
type: string
description: The balance currency symbol.
created:
type: string
description: Time the transaction was created.
updated:
type:
- string
- 'null'
description: Time the transaction was last updated.
expire_date:
type:
- string
- 'null'
description: The expiration date of the transaction (deposits only).
OrganizationEstimationObject:
type: object
description: An estimation of all organization spend.
properties:
total:
type: string
description: The total estimated price for the organization.
sub_total:
type: string
description: The sub total for all projects and sellables.
vouchers:
type: string
description: The total amount of vouchers.
user_licenses:
type: object
description: An estimation of user licenses cost.
properties:
base:
type: object
properties:
count:
type: integer
description: The number of base user licenses.
total:
type: string
description: The total price for base user licenses.
list:
type: object
properties:
admin_user:
type: object
description: An estimation of admin users cost.
properties:
count:
type: integer
description: The number of admin user licenses.
total:
type: string
description: The total price for admin user licenses.
viewer_user:
type: object
description: An estimation of viewer users cost.
properties:
count:
type: integer
description: The number of viewer user licenses.
total:
type: string
description: The total price for viewer user licenses.
user_management:
type: object
properties:
count:
type: integer
description: The number of user_management licenses.
total:
type: string
description: The total price for user_management licenses.
list:
type: object
properties:
standard_management_user:
type: object
description: An estimation of standard_management_user cost.
properties:
count:
type: integer
description: The number of standard_management_user licenses.
total:
type: string
description: The total price for standard_management_user licenses.
advanced_management_user:
type: object
description: An estimation of advanced_management_user cost.
properties:
count:
type: integer
description: The number of advanced_management_user licenses.
total:
type: string
description: The total price for advanced_management_user licenses.
user_management:
type: string
description: An estimation of the advanced user management sellable cost.
support_level:
type: string
description: The total monthly price for premium support.
subscriptions:
type: object
description: An estimation of subscriptions cost.
properties:
total:
type: string
description: The total price for subscriptions.
list:
type: array
description: The list of active subscriptions.
items:
description: Details of a subscription
type: object
properties:
license_id:
type: string
description: The id of the subscription.
project_title:
type: string
description: The name of the project.
total:
type: string
description: The total price for the subscription.
usage:
type: object
description: The detail of the usage for the subscription.
properties:
cpu:
type: number
description: The total cpu for this subsciption.
memory:
type: number
description: The total memory for this subsciption.
storage:
type: number
description: The total storage for this subsciption.
environments:
type: integer
description: The total environments for this subsciption.
OrganizationAlertConfig:
type: object
description: The alert configuration for an organization.
properties:
id:
type: string
description: Type of alert (e.g. "billing")
active:
type: boolean
description: Whether the billing alert should be active or not.
alerts_sent:
type: number
description: Number of alerts sent.
last_alert_at:
type:
- string
- 'null'
description: The datetime the alert was last sent.
updated_at:
type:
- string
- 'null'
description: The datetime the alert was last updated.
config:
type:
- object
- 'null'
description: Configuration for threshold and mode.
properties:
threshold:
type: object
description: Data regarding threshold spend.
properties:
formatted:
type: string
description: Formatted threshold value.
amount:
type: number
description: Threshold value.
currency_code:
type: string
description: Threshold currency code.
currency_symbol:
type: string
description: Threshold currency symbol.
mode:
type: string
description: The mode of alert.
securitySchemes:
OAuth2:
type: oauth2
flows:
authorizationCode:
tokenUrl: https://auth.api.platform.sh/oauth2/token
refreshUrl: https://auth.api.platform.sh/oauth2/token
scopes: {}
authorizationUrl: https://auth.api.platform.sh/oauth2/authorize
description: ''
OAuth2Admin:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://auth.api.platform.sh/oauth2/token
refreshUrl: ''
scopes:
admin: administrative operations
description: ''
x-tagGroups:
- name: Organization Administration
tags:
- Organizations
- Organization Members
- Organization Invitations
- Organization Projects
- Add-ons
- name: Project Administration
tags:
- Project
- Domain Management
- Cert Management
- Certificate Provisioner
- Project Variables
- Repository
- Third-Party Integrations
- Support
- name: Environments
tags:
- Environment
- Environment Backups
- Environment Type
- Environment Variables
- Routing
- Source Operations
- Runtime Operations
- Deployment
- Autoscaling
- name: User Activity
tags:
- Project Activity
- Environment Activity
- name: Project Access
tags:
- Project Invitations
- Teams
- Team Access
- User Access
- name: Account Management
tags:
- API Tokens
- Connections
- MFA
- Users
- User Profiles
- SSH Keys
- Plans
- name: Billing
tags:
- Organization Management
- Subscriptions
- Orders
- Invoices
- Discounts
- Vouchers
- Records
- Profiles
- name: Global Info
tags:
- Project Discovery
- References
- Regions
- name: Internal APIs
tags:
- Project Settings
- Environment Settings
- Deployment Target
- System Information
- Container Profile