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.
All 92 tools
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/platform.sh-organization-projects-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 email required.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Upsun.com Rest Organization Projects API
version: '1.0'
contact:
name: Support
url: https://upsun.com/contact-us/
termsOfService: https://upsun.com/trust-center/legal/tos/
description: "# Introduction\n\nUpsun, formerly Platform.sh, is a container-based Platform-as-a-Service. Our main API\nis simply Git. With a single `git push` and a couple of YAML files in\nyour repository you can deploy an arbitrarily complex cluster.\nEvery [**Project**](#tag/Project) can have multiple applications (PHP,\nNode.js, Python, Ruby, Go, etc.) and managed, automatically\nprovisioned services (databases, message queues, etc.).\n\nEach project also comes with multiple concurrent\nlive staging/development [**Environments**](#tag/Environment).\nThese ephemeral development environments\nare automatically created every time you push a new branch or create a\npull request, and each has a full copy of the data of its parent branch,\nwhich is created on-the-fly in seconds.\n\nOur Git implementation supports integrations with third party Git\nproviders such as GitHub, Bitbucket, or GitLab, allowing you to simply\nintegrate Upsun into your existing workflow.\n\n## Using the REST API\n\nIn addition to the Git API, we also offer a REST API that allows you to manage\nevery aspect of the platform, from managing projects and environments,\nto accessing accounts and subscriptions, to creating robust workflows\nand integrations with your CI systems and internal services.\n\nThese API docs are generated from a standard **OpenAPI (Swagger)** Specification document\nwhich you can find here in [YAML](openapispec-upsun.yaml) and in [JSON](openapispec-upsun.json) formats.\n\nThis RESTful API consumes and produces HAL-style JSON over HTTPS,\nand any REST library can be used to access it. On GitHub, we also host\na few API libraries that you can use to make API access easier, such as our\n[PHP API client](https://github.com/upsun/upsun-sdk-php).\n\nIn order to use the API you will first need to have an [Upsun account](https://auth.upsun.com/register/)\nand [create an API Token](https://docs.upsun.com/anchors/cli/api-token/).\n\n# Authentication\n\n## OAuth2\n\nAPI authentication is done with OAuth2 access tokens.\n\n### API tokens\n\nYou can use an API token as one way to get an OAuth2 access token. This\nis particularly useful in scripts, e.g. for CI pipelines.\n\nTo create an API token, go to the \"API Tokens\" section\nof the \"Account Settings\" tab on the [Console](https://console.upsun.com).\n\nTo exchange this API token for an access token, a `POST` request\nmust be made to `https://auth.upsun.com/oauth2/token`.\n\nThe request will look like this in cURL:\n\n<pre>\ncurl -u platform-api-user: \\\n -d 'grant_type=api_token&api_token=<em><b>API_TOKEN</b></em>' \\\n https://auth.upsun.com/oauth2/token\n</pre>\n\nThis will return a \"Bearer\" access token that\ncan be used to authenticate further API requests, for example:\n\n<pre>\n{\n \"access_token\": \"<em><b>abcdefghij1234567890</b></em>\",\n \"expires_in\": 900,\n \"token_type\": \"bearer\"\n}\n</pre>\n\n### Using the Access Token\n\nTo authenticate further API requests, include this returned bearer token\nin the `Authorization` header. For example, to retrieve a list of\n[Projects](#tag/Project)\naccessible by the current user, you can make the following request\n(substituting the dummy token for your own):\n\n<pre>\ncurl -H \"Authorization: Bearer <em><b>abcdefghij1234567890</b></em>\" \\\n https://api.upsun.com/projects\n</pre>\n\n# HAL Links\n\nMost endpoints in the API return fields which defines a HAL\n(Hypertext Application Language) schema for the requested endpoint.\nThe particular objects returns and their contents can vary by endpoint.\nThe payload examples we give here for the requests do not show these\nelements. These links can allow you to create a fully dynamic API client\nthat does not need to hardcode any method or schema.\n\nUnless they are used for pagination we do not show the HAL links in the\npayload examples in this documentation for brevity and as their content\nis contextual (based on the permissions of the user).\n\n## _links Objects\n\nMost endpoints that respond to `GET` requests will include a `_links` object\nin their response. The `_links` object contains a key-object pair labelled `self`, which defines\ntwo further key-value pairs:\n\n* `href` - A URL string referring to the fully qualified name of the returned object. For many endpoints, this will be the direct link to the API endpoint on the region gateway, rather than on the general API gateway. This means it may reference a host of, for example, `eu-2.platform.sh` rather than `api.upsun.com`.\n* `meta` - An object defining the OpenAPI Specification (OAS) [schema object](https://swagger.io/specification/#schemaObject) of the component returned by the endpoint.\n\nThere may be zero or more other fields in the `_links` object resembling fragment identifiers\nbeginning with a hash mark, e.g. `#edit` or `#delete`. Each of these keys\nrefers to a JSON object containing two key-value pairs:\n\n* `href` - A URL string referring to the path name of endpoint which can perform the action named in the key.\n* `meta` - An object defining the OAS schema of the endpoint. This consists of a key-value pair, with the key defining an HTTP method and the value defining the [operation object](https://swagger.io/specification/#operationObject) of the endpoint.\n\nTo use one of these HAL links, you must send a new request to the URL defined\nin the `href` field which contains a body defined the schema object in the `meta` field.\n\nFor example, if you make a request such as `GET /projects/abcdefghij1234567890`, the `_links`\nobject in the returned response will include the key `#delete`. That object\nwill look something like this fragment:\n\n```\n\"#delete\": {\n \"href\": \"/api/projects/abcdefghij1234567890\",\n \"meta\": {\n \"delete\": {\n \"responses\": {\n . . . // Response definition omitted for space\n },\n \"parameters\": []\n }\n }\n}\n```\n\nTo use this information to delete a project, you would then send a `DELETE`\nrequest to the endpoint `https://api.upsun.com/api/projects/abcdefghij1234567890`\nwith no body or parameters to delete the project that was originally requested.\n\n## _embedded Objects\n\nRequests to endpoints which create or modify objects, such as `POST`, `PATCH`, or `DELETE`\nrequests, will include an `_embedded` key in their response. The object\nrepresented by this key will contain the created or modified object. This\nobject is identical to what would be returned by a subsequent `GET` request\nfor the object referred to by the endpoint.\n"
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:
- BearerAuth: []
tags:
- name: Organization Projects
paths:
/organizations/{organization_id}/projects:
get:
summary: List projects
description: Retrieves a list of projects for the specified organization.
operationId: list-org-projects
tags:
- Organization Projects
parameters:
- $ref: '#/components/parameters/OrganizationID'
- in: query
name: filter[id]
description: Allows filtering by `id` using one or more operators.
style: deepObject
explode: true
schema:
$ref: '#/components/schemas/StringFilter'
- $ref: '#/components/parameters/FilterProjectTitle'
- $ref: '#/components/parameters/FilterProjectStatus'
- $ref: '#/components/parameters/FilterUpdatedAt'
- $ref: '#/components/parameters/FilterCreatedAt'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageBefore'
- $ref: '#/components/parameters/PageAfter'
- in: query
name: sort
description: 'Allows sorting by a single field.<br>
Use a dash ("-") to sort descending.<br>
Supported fields: `id`, `region`, `title`, `type`, `plan`, `status`, `created_at`, `updated_at`.
'
schema:
type: string
example: -updated_at
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of items across pages.
items:
type: array
items:
$ref: '#/components/schemas/OrganizationProject'
facets:
$ref: '#/components/schemas/ProjectFacets'
_links:
$ref: '#/components/schemas/ListLinks'
additionalProperties: false
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
post:
summary: Create project
description: Creates a new project in the specified organization.
operationId: create-org-project
tags:
- Organization Projects
parameters:
- $ref: '#/components/parameters/OrganizationID'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- region
properties:
organization_id:
$ref: '#/components/schemas/OrganizationID'
region:
$ref: '#/components/schemas/RegionID'
title:
$ref: '#/components/schemas/ProjectTitle'
type:
$ref: '#/components/schemas/ProjectType'
plan:
$ref: '#/components/schemas/ProjectPlan'
default_branch:
$ref: '#/components/schemas/ProjectDefaultBranch'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationProject'
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'503':
$ref: '#/components/responses/ServiceUnavailable'
/organizations/{organization_id}/projects/provisioning:
get:
summary: Stream provisioning progress
description: 'Streams real-time provisioning progress for projects being created in the
specified organization. The response is an NDJSON stream where each line
is a JSON object representing a provisioning event.
The stream emits events as provisioning stages complete and terminates
automatically when all in-flight projects finish (or fail). A keep-alive
event is sent periodically to prevent connection timeouts.
The body is a newline-delimited stream of JSON objects.
Each line is a single `ProvisionEvent`.
The `data`, `done`, and `error` events include a `steps` array listing the ordered provisioning steps.
Event types:
- `data` — a provisioning stage completed
- `done` — provisioning finished successfully
- `error` — provisioning failed
- `keep_alive` — connection keep-alive
'
operationId: stream-org-project-provisioning
tags:
- Organization Projects
parameters:
- $ref: '#/components/parameters/OrganizationID'
responses:
'200':
description: OK
content:
application/x-ndjson:
schema:
$ref: '#/components/schemas/ProvisionEvent'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
/organizations/{organization_id}/projects/{project_id}:
get:
summary: Get project
description: Retrieves the specified project.
operationId: get-org-project
tags:
- Organization Projects
parameters:
- $ref: '#/components/parameters/OrganizationID'
- $ref: '#/components/parameters/ProjectID'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationProject'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
patch:
summary: Update project
description: Updates the specified project.
operationId: update-org-project
tags:
- Organization Projects
parameters:
- $ref: '#/components/parameters/OrganizationID'
- $ref: '#/components/parameters/ProjectID'
requestBody:
content:
application/json:
schema:
type: object
properties:
title:
$ref: '#/components/schemas/ProjectTitle'
plan:
$ref: '#/components/schemas/ProjectPlan'
timezone:
$ref: '#/components/schemas/ProjectTimeZone'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationProject'
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'503':
$ref: '#/components/responses/ServiceUnavailable'
delete:
summary: Delete project
description: Deletes the specified project.
operationId: delete-org-project
tags:
- Organization Projects
parameters:
- $ref: '#/components/parameters/OrganizationID'
- $ref: '#/components/parameters/ProjectID'
responses:
'204':
$ref: '#/components/responses/NoContent'
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'503':
$ref: '#/components/responses/ServiceUnavailable'
/organizations/{organization_id}/projects/{project_id}/metrics/carbon:
get:
summary: Query project carbon emissions metrics
description: Queries the carbon emission data for the specified project using the supplied parameters.
operationId: query-project-carbon
tags:
- Organization Projects
parameters:
- $ref: '#/components/parameters/OrganizationID'
- $ref: '#/components/parameters/ProjectID'
- $ref: '#/components/parameters/TimeRangeFrom'
- $ref: '#/components/parameters/TimeRangeTo'
- $ref: '#/components/parameters/TimeRangeInterval'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectCarbon'
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
components:
schemas:
DateTimeFilter:
type: object
properties:
eq:
type: string
description: Equal
ne:
type: string
description: Not equal
between:
type: string
description: Between (comma-separated list)
gt:
type: string
description: Greater than
gte:
type: string
description: Greater than or equal
lt:
type: string
description: Less than
lte:
type: string
description: Less than or equal
MetricsValue:
type: object
properties:
value:
description: The measured value of the metric for the given time interval.
start_time:
description: The timestamp at which the time interval began.
additionalProperties: false
ProjectType:
type: string
description: The type of projects.
enum:
- grid
- dedicated
StringFilter:
type: object
properties:
eq:
type: string
description: Equal
ne:
type: string
description: Not equal
in:
type: string
description: In (comma-separated list)
nin:
type: string
description: Not in (comma-separated list)
between:
type: string
description: Between (comma-separated list)
contains:
type: string
description: Contains
starts:
type: string
description: Starts with
ends:
type: string
description: Ends with
Link:
type: object
title: Link
description: A hypermedia link to the {current, next, previous} set of items.
properties:
href:
type: string
description: URL of the link
CreatedAt:
type: string
format: date-time
description: The date and time when the resource was created.
OrganizationProject:
type: object
properties:
id:
$ref: '#/components/schemas/ProjectID'
organization_id:
$ref: '#/components/schemas/OrganizationID'
subscription_id:
$ref: '#/components/schemas/SubscriptionID'
vendor:
type: string
description: Vendor of the project.
region:
$ref: '#/components/schemas/RegionID'
title:
$ref: '#/components/schemas/ProjectTitle'
type:
$ref: '#/components/schemas/ProjectType'
plan:
$ref: '#/components/schemas/ProjectPlan'
timezone:
$ref: '#/components/schemas/ProjectTimeZone'
default_branch:
$ref: '#/components/schemas/ProjectDefaultBranch'
status:
$ref: '#/components/schemas/ProjectStatus'
trial_plan:
$ref: '#/components/schemas/ProjectTrialPlan'
project_ui:
$ref: '#/components/schemas/ProjectUI'
dedicated_tag:
type:
- string
- 'null'
allOf:
- $ref: '#/components/schemas/ProjectDedicatedTag'
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
activities:
description: Activities information for the project.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Activity'
fastly_service_ids:
description: Fastly service IDs for the project.
type:
- array
- 'null'
items:
type: string
project_options:
type:
- object
- 'null'
allOf:
- $ref: '#/components/schemas/ProjectOptionsAggregated'
_links:
type: object
properties:
self:
type: object
description: Link to the current project.
properties:
href:
type: string
description: URL of the link.
api:
type:
- object
- 'null'
description: Link to the regional API endpoint. Only present if user has project-level access.
properties:
href:
type: string
description: URL of the link.
subscription:
type:
- object
- 'null'
description: Link to the subscription. Only present if project has a subscription.
properties:
href:
type: string
description: URL of the link.
view_usage_alerts:
type:
- object
- 'null'
description: Link to view usage alerts. Only present if user has view permission.
properties:
href:
type: string
description: URL of the link.
update:
type:
- object
- 'null'
description: Link for updating the current project. Only present if user has update permission.
properties:
href:
type: string
description: URL of the link.
method:
type: string
description: The HTTP method to use.
plan_uri:
type:
- object
- 'null'
description: Link to the billing plan page. Only present if user has manage permission.
properties:
href:
type: string
description: URL of the link.
delete:
type:
- object
- 'null'
description: Link for deleting the current project. Only present if user has delete permission.
properties:
href:
type: string
description: URL of the link.
method:
type: string
description: The HTTP method to use.
update_usage_alerts:
type:
- object
- 'null'
description: Link to update usage alerts. Only present if user has billing permission.
properties:
href:
type: string
description: URL of the link.
method:
type: string
description: The HTTP method to use.
activities:
type:
- object
- 'null'
description: Link to the project's activities. Only present if user has view permission.
properties:
href:
type: string
description: URL of the link.
addons:
type:
- object
- 'null'
description: Link to the project's add-ons. Only present if user has view permission.
properties:
href:
type: string
description: URL of the link.
additionalProperties: false
MetricsMetadata:
type: object
properties:
from:
description: The value used to calculate the lower bound of the temporal query. Inclusive.
to:
description: The truncated value used to calculate the upper bound of the temporal query. Exclusive.
interval:
description: The interval used to group the metric values.
units:
description: The units associated with the provided values.
additionalProperties: false
AggregatedFeatures:
type: object
properties:
backups:
type:
- object
- 'null'
description: Backup features configuration.
MetricsValues:
type: array
items:
$ref: '#/components/schemas/MetricsValue'
ProjectPlan:
type: string
description: The project plan.
ProjectOptionsAggregated:
type: object
properties:
billing:
type:
- object
- 'null'
defaults:
type:
- object
- 'null'
enforced:
type:
- object
- 'null'
initialize:
type:
- object
- 'null'
plans:
type:
- array
- 'null'
items:
type: string
regions:
type:
- array
- 'null'
items:
type: string
plan_titles:
type:
- object
- 'null'
allOf:
- $ref: '#/components/schemas/PlanTitles'
sellables:
type:
- object
- 'null'
allOf:
- $ref: '#/components/schemas/AggregatedSellables'
features:
type:
- object
- 'null'
allOf:
- $ref: '#/components/schemas/AggregatedFeatures'
container_sizes:
type:
- array
- 'null'
items:
type: string
description: Container sizes configuration.
debug:
type:
- object
- 'null'
description: Debug configuration.
additionalProperties: false
ProjectUI:
description: The URL for the project's user interface.
type: string
ProjectID:
type: string
description: The ID of the project.
ProjectCarbon:
type: object
properties:
project_id:
$ref: '#/components/schemas/ProjectID'
project_title:
$ref: '#/components/schemas/ProjectTitle'
meta:
$ref: '#/components/schemas/MetricsMetadata'
values:
$ref: '#/components/schemas/MetricsValues'
total:
$ref: '#/components/schemas/CarbonTotal'
additionalProperties: false
ListLinks:
type: object
properties:
self:
$ref: '#/components/schemas/Link'
previous:
$ref: '#/components/schemas/Link'
next:
$ref: '#/components/schemas/Link'
PlanTitles:
type: object
description: Map of plan IDs to their human-readable titles.
additionalProperties:
type: string
ProjectTrialPlan:
description: Whether the project is currently on a trial plan.
type: boolean
SubscriptionID:
type: string
description: The ID of the subscription.
UpdatedAt:
type: string
format: date-time
description: The date and time when the resource was last updated.
ProjectDedicatedTag:
type: string
description: Dedicated tag.
ProjectDefaultBranch:
type: string
description: Default branch.
ProvisionEvent:
type: object
description: A single event in the provisioning progress stream.
required:
- type
properties:
type:
type: string
description: The event type.
enum:
- data
- done
- error
- keep_alive
project_id:
type: string
description: The ID of the project being provisioned.
stage:
type: string
description: The current provisioning stage.
label:
type: string
description: A human-readable label for the current stage.
reason:
type: string
description: The reason for failure (only present on error events).
timestamp:
type: string
format: date-time
description: The time the event was emitted.
steps:
type: array
description: Ordered list of provisioning steps.
items:
$ref: '#/components/schemas/ProvisionStep'
additionalProperties: false
Error:
type: object
properties:
error:
type: string
description: Error message
required:
- error
RegionID:
type: string
description: The machine name of the region where the project is located.
CarbonTotal:
type: number
description: The calculated total of the metric for the given interval.
OrganizationID:
type: string
description: The ID of the organization.
ProvisionStep:
type: object
description: A single step in the provisioning plan.
required:
- stage
- label
properties:
stage:
type: string
description: The step identifier.
label:
type: string
description: A human-readable label for the step.
additionalProperties: false
AggregatedSellables:
type: object
description: Map of sellable names to their configuration.
additionalProperties:
type: object
description: Sellable product configuration.
Activity:
type: object
properties:
id:
type: string
title: Activity Identifier
description: The identifier of Activity
created_at:
type:
- string
- 'null'
format: date-time
title: Creation date
description: The creation date
updated_at:
type:
- string
- 'null'
format: date-time
title: Update date
description: The update date
type:
type: string
title: Type
description: The type of the activity
parameters:
type: object
title: Parameters
description: The parameters of the activity
project:
type: string
title: Project
description: The project the activity belongs to
integration:
type: string
title: Integration
description: The integration the activity belongs to
environments:
type: array
items:
type: string
title: Environments
description: The environments related to the activity
state:
type: string
enum:
- cancelled
- complete
- in_progress
- pending
- scheduled
- staged
title: State
description: The state of the activity
result:
type:
- string
- 'null'
enum:
- failure
- success
title: Result
description: The result of the activity
failure_reason:
type:
- string
- 'null'
enum:
- error
- shell
title: Failure Reason
description: The reason for activity failure
started_at:
type:
- string
- 'null'
format: date-time
title: Start date
description: The start date of the activity
completed_at:
type:
- string
- 'null'
format: date-time
title: Completion date
description: The completion date of the activity
completion_percent:
type: integer
title: Completion percentage
description: The completion percentage of the activity
cancelled_at:
type:
- string
- 'null'
format: date-time
title: Cancellation date
description: The Cancellation date of the activity
timings:
type: object
additionalProperties:
type: number
format: float
title: Timings
description: Timings related to different phases of the activity
log:
type: string
title: Log
description: The log of the activity
deprecated: true
x-stability: DEPRECATED
payload:
type: object
title: Payload
description: The payload of the activity
description:
type:
- string
- 'null'
title: Activity HTML description
description: The description of the activity, formatted with HTML
text:
type:
- string
- 'null'
title: Activity text description
description: The description of the activity, formatted as plain text
expires_at:
type:
- string
- 'null'
format: date-time
title: Expiration date
description: The
# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/platform.sh/refs/heads/main/openapi/platform.sh-organization-projects-api-openapi.yml