API Designer Experience API

1.0.0

Overview

Statistics
79 Operations
0 Skills
Design Category
Design and manage API specifications and fragments in Design Center. Create projects, manage branches, modify files, and publish to Exchange.

Servers

  • https://anypoint.mulesoft.com/designcenter/api-designer
  • https://{region}.anypoint.mulesoft.com/designcenter/api-designer
  • https://{region}.platform.mulesoft.com/designcenter/api-designer

Authentication & Security

  • bearerAuth http

    Bearer token authentication. Login endpoint: https://anypoint.mulesoft.com/accounts/api/login

  • clientAuth oauth2

    OAuth2 client credentials. Token endpoint: https://anypoint.mulesoft.com/accounts/api/v2/oauth2/token

Check service health getPing

GET

Try it out

Custom Query Parameters
Custom Headers
to check if service is up

Response

Successful operation.

Get service status getStatus

GET

Try it out

Custom Query Parameters
Custom Headers
to check if service is up

Response

Successful operation.

Get service health status getHealth

GET

Try it out

Custom Query Parameters
Custom Headers
to check if service is up

Response

Successful operation.

Check service readiness getReady

GET

Try it out

Custom Query Parameters
Custom Headers
Readiness check, reports status of dependent services (e.g. redis)

Response

Successful operation.

Get client configuration getConfig

GET

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Returns client configuration such as currentDate, expirationTime, muleOrganizationId, retryTimes, retryTimeout and feature flags

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

Successful operation.

Resolve feature flags resolveFeatures

POST

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Resolves a set of feature flags by name for the current user

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Request Body

json
items: array
Array items

Response

Successful operation.
Examples
application/json
{ "design-center-pkce-ready": true, "api-designer-ui-pkce-ready": false }

List organizations the user belongs to listOrganizations

GET

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Retrieves the organizations the current user is a member of

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

Successful operation.

Get organization settings getOrganizationSettings

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieves settings for organization

Path Parameters

organizationId *: string
The organizationId to identify the target resource.

Header Parameters

authorization *: string
Bearer Access Token
x-all-settings: boolean

Response

json
Successful operation.
branchName: string
Name of the default branch. Used in request bodies (and in the response when x-all-settings is not true)
defaultBranch: string
Name of the default branch, as returned in the response when x-all-settings is not true
githubIntegration: boolean
Whether Github integration is enabled for the organization. Used in request bodies when x-all-settings is true
defaultBranchSetting: object
Default branch setting, returned when x-all-settings is true
githubIntegrationSetting: object
Github integration setting, returned when x-all-settings is true
organizationId: string
lastUpdatedDate: number
updatedBy: string

Update organization settings updateOrganizationSettings

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Changes settings for organization

Path Parameters

organizationId *: string
The organizationId to identify the target resource.

Header Parameters

authorization *: string
Bearer Access Token
x-all-settings: boolean

Request Body

json
branchName: string
Name of the default branch. Used in request bodies (and in the response when x-all-settings is not true)
defaultBranch: string
Name of the default branch, as returned in the response when x-all-settings is not true
githubIntegration: boolean
Whether Github integration is enabled for the organization. Used in request bodies when x-all-settings is true
defaultBranchSetting: object
Default branch setting, returned when x-all-settings is true
githubIntegrationSetting: object
Github integration setting, returned when x-all-settings is true
organizationId: string
lastUpdatedDate: number
updatedBy: string

Response

json
Successful operation.
branchName: string
Name of the default branch. Used in request bodies (and in the response when x-all-settings is not true)
defaultBranch: string
Name of the default branch, as returned in the response when x-all-settings is not true
githubIntegration: boolean
Whether Github integration is enabled for the organization. Used in request bodies when x-all-settings is true
defaultBranchSetting: object
Default branch setting, returned when x-all-settings is true
githubIntegrationSetting: object
Github integration setting, returned when x-all-settings is true
organizationId: string
lastUpdatedDate: number
updatedBy: string

Get organization admin permissions getOrganizationPermissions

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieves admin permissions

Path Parameters

organizationId *: string
The organizationId to identify the target resource.

Header Parameters

authorization *: string
Bearer Access Token

Response

json
Successful operation.
isAdmin *: boolean
Whether the current user is an administrator of the organization

Get organization Exchange facets getOrganizationExchangeFacets

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieves Exchange facets for the given organization

Path Parameters

organizationId *: string
The organizationId to identify the target resource.

Header Parameters

authorization *: string
Bearer Access Token

Response

json
Successful operation.
types *: array
Supported Exchange Asset types
categories *: array
Exchange Categories used in the given organization
organizations *: array
Organizations that have published Exchange assets visible to the current user
tags *: array
Exchange tags used in the given organization
status *: array
Exchange asset statuses used in the given organization
fields *: array
Additional searchable fields available for Exchange assets

List organization identities listOrganizationIdentities

GET

Try it out

Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieves identities (users/teams) belonging to the given organization, optionally filtered by search term

Path Parameters

organizationId *: string
The organizationId to identify the target resource.

Query Parameters

search: string
Search term to filter identities by

Header Parameters

authorization *: string
Bearer Access Token

Response

Successful operation.

Get documentation content getDocumentation

GET

Try it out

Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieves documentation content for the given language

Query Parameters

language: string
Language of the documentation to retrieve. Although the query parameter itself is optional, omitting it results in a 400 response

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

Successful operation.

List projects the user can access listProjects

GET

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Gets all the projects that the user has access

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

json
Successful operation.
items: array
Array items
Examples
application/json
[ { "id": "string", "type": "string" } ]

Create project createProject

POST

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new project

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Request Body

json
name *: string
description: string
classifier *: string
Type of asset this project represents. Required
subType: string
format *: string
File format for the project. Allowed values depend on classifier: raml -> yaml; oas / evented-api -> yaml or json; json-schema -> json
version *: string
visualDesignerMode: boolean
Whether the project is created in Visual Designer mode. Not allowed when classifier is a fragment classifier
vcsStorageType: string
Storage backend for the project. Defaults to GIT_INTERNAL when omitted
externalUri: string
URI of the external git repository. Required when vcsStorageType is GIT_EXTERNAL
externalUriSchema: string
Schema of the external URI (e.g. FILE, HTTPS). Required when vcsStorageType is GIT_EXTERNAL
externalOrgName: string
Name of the external git organization/owner hosting the repository
externalOrgType: string
Type of the external git organization (e.g. USER, ORGANIZATION)
clone: boolean
Whether this creation request is cloning an existing project

Response

json
Resource created successfully.
organizationId *: string
id *: string
name *: string
Project name
description *: string
Project description
type *: string
Project type
externalUri: string
URI of the external git repository
createdBy *: string
Name of the user that created the project
createdDate *: integer(long)
Creation date of the project
lastUpdatedDate *: integer(long)
Last update date of the project
defaultBranch *: string
Name of the default branch of the project
deleted *: boolean
Whether the project has been deleted
vcsStorageType *: string
Storage backend for the project
initialWorkingDirectory: object
Initial working directory metadata for the project
Examples
application/json
{ "organizationId": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22", "id": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22", "name": "string", "description": "string", "type": "string", "createdBy": "string", "createdDate": 0 }

Get VCS credentials for Github sync getProjectCredentials

GET

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Retrieve VCS credentials associated to the given user. Used for Github sync

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

Successful operation.

Delete VCS credentials for Github sync deleteProjectCredentials

DELETE

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Delete VCS credentials associated to the given user. Used for Github sync

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

Operation completed successfully with no content returned.

Import project from zip file importProject

POST

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a project from a zip file containing files

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Request Body

json
name *: string
description: string
classifier: string
Type of asset this project represents. Falls back to the deprecated type field when omitted
type: string
Deprecated alias for classifier, kept for backwards compatibility
subType: string
Fragment subtype. Required when classifier is a fragment classifier (raml-fragment, oas-components), forbidden otherwise
format: string
File format. Defaults based on classifier when omitted
version: string
Spec version for the project. Defaults based on classifier when omitted
mainFile: string
Path, within the zip file, of the project's main/entry file
zipFile *: string(binary)
Zip file (application/zip or application/x-zip-compressed) containing the project's files
dependencies: string
JSON-stringified array of dependencies, e.g. [{"groupId":"gid","assetId":"aid","version":"1.0.0"}]

Response

json
Resource created successfully.
organizationId *: string
id *: string
name *: string
Project name
description *: string
Project description
type *: string
Project type
externalUri: string
URI of the external git repository
createdBy *: string
Name of the user that created the project
createdDate *: integer(long)
Creation date of the project
lastUpdatedDate *: integer(long)
Last update date of the project
defaultBranch *: string
Name of the default branch of the project
deleted *: boolean
Whether the project has been deleted
vcsStorageType *: string
Storage backend for the project
initialWorkingDirectory: object
Initial working directory metadata for the project
Examples
application/json
{ "organizationId": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22", "id": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22", "name": "string", "description": "string", "type": "string", "createdBy": "string", "createdDate": 0 }

Get Design Center general permissions getDesignCenterPermissions

GET

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Gets design center general permissions. eg Create projects

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

json
Successful operation.
canCreate *: boolean
canPublish *: boolean
canAdministrate *: boolean

Get project by ID getProjectById

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Get project data

Path Parameters

projectId *: string

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

json
Successful operation.
organizationId *: string
id *: string
name *: string
Project name
description *: string
Project description
type *: string
Project type
externalUri: string
URI of the external git repository
createdBy *: string
Name of the user that created the project
createdDate *: integer(long)
Creation date of the project
lastUpdatedDate *: integer(long)
Last update date of the project
defaultBranch *: string
Name of the default branch of the project
deleted *: boolean
Whether the project has been deleted
vcsStorageType *: string
Storage backend for the project
initialWorkingDirectory: object
Initial working directory metadata for the project
Examples
application/json
{ "organizationId": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22", "id": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22", "name": "string", "description": "string", "type": "string", "createdBy": "string", "createdDate": 0 }

Patch project metadata patchProject

PATCH

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Patches project metadata.
CreatedBy is only editable by the Project Owner or Organization Admins

Path Parameters

projectId *: string

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Request Body

json
createdBy *: string
New Project owner id

Response

json
Successful operation.
organizationId *: string
id *: string
name *: string
Project name
description *: string
Project description
type *: string
Project type
externalUri: string
URI of the external git repository
createdBy *: string
Name of the user that created the project
createdDate *: integer(long)
Creation date of the project
lastUpdatedDate *: integer(long)
Last update date of the project
defaultBranch *: string
Name of the default branch of the project
deleted *: boolean
Whether the project has been deleted
vcsStorageType *: string
Storage backend for the project
initialWorkingDirectory: object
Initial working directory metadata for the project
Examples
application/json
{ "organizationId": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22", "id": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22", "name": "string", "description": "string", "type": "string", "createdBy": "string", "createdDate": 0 }

Delete project deleteProject

DELETE

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Deletes the given project

Path Parameters

projectId *: string

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

Operation completed successfully with no content returned.

Delete all project files deleteProjectFiles

DELETE

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Deletes all project files, except reserved ones (exchange modules, exchange.json, designer.json, .gitignore)

Path Parameters

projectId *: string

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token
x-if-match: string
etag to check for concurrency conflicts

Response

Successful operation.

Rename project renameProject

PUT

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Renames the given project

Path Parameters

projectId *: string

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Request Body

json
name *: string

Response

json
Successful operation.
organizationId *: string
id *: string
name *: string
Project name
description *: string
Project description
type *: string
Project type
externalUri: string
URI of the external git repository
createdBy *: string
Name of the user that created the project
createdDate *: integer(long)
Creation date of the project
lastUpdatedDate *: integer(long)
Last update date of the project
defaultBranch *: string
Name of the default branch of the project
deleted *: boolean
Whether the project has been deleted
vcsStorageType *: string
Storage backend for the project
initialWorkingDirectory: object
Initial working directory metadata for the project
Examples
application/json
{ "organizationId": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22", "id": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22", "name": "string", "description": "string", "type": "string", "createdBy": "string", "createdDate": 0 }

Clone project cloneProject

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Clones the given project into a new one

Path Parameters

projectId *: string

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Request Body

json
name *: string
branch: string

Response

json
Successful operation.
organizationId *: string
id *: string
name *: string
Project name
description *: string
Project description
type *: string
Project type
externalUri: string
URI of the external git repository
createdBy *: string
Name of the user that created the project
createdDate *: integer(long)
Creation date of the project
lastUpdatedDate *: integer(long)
Last update date of the project
defaultBranch *: string
Name of the default branch of the project
deleted *: boolean
Whether the project has been deleted
vcsStorageType *: string
Storage backend for the project
initialWorkingDirectory: object
Initial working directory metadata for the project
Examples
application/json
{ "organizationId": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22", "id": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22", "name": "string", "description": "string", "type": "string", "createdBy": "string", "createdDate": 0 }

Patch project settings patchProjectSettings

PATCH

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Sets project settings, e.g. defaultBranch

Path Parameters

projectId *: string

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Request Body

json
defaultBranch: string

Response

Successful operation.

List project changes listProjectChanges

GET

Try it out

Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Lists all changes (commits) of the project

Path Parameters

projectId *: string

Query Parameters

pageSize: number
Number of changes to retrieve per page
pageIndex: number
Page index of results to retrieve

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

Successful operation.

List files changed in a commit listCommitFiles

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Gets the list of files involved in the given commit

Path Parameters

projectId *: string
commitId *: string
The commitId to identify the target resource.

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

Successful operation.

Get file content at a specific commit getCommitFile

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Gets the given file at the given commit id. filePath must be uri compliant, / must be escaped

Path Parameters

projectId *: string
commitId *: string
The commitId to identify the target resource.
filePath *: string
File Path to retrieve. Must be URI complain and escape '/' characters

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

Successful operation.

List branches listBranches

GET

Try it out

Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
List branches

Path Parameters

projectId *: string

Query Parameters

local: boolean
When true, it retrieves branches from local copy instead of git bare repository
metadata: boolean
When true, it retrieves extra branches metadata such as lastPublishedVersion

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

json
List of existing branches
items: array
Array items
Examples
application/json
[ { "id": "string", "type": "string" } ]

Create branch createBranch

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates new branch

Path Parameters

projectId *: string

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Request Body

json
name *: string
Name of the branch
commitId *: string
Commit ID
baseBranch: string
Base branch used when creating the new branch. If this value is provided, it has precedence over commitId

Response

json
Resource created successfully.
name *: string
Name of the branch
commitId *: string
Commit ID
Examples
application/json
{ "name": "master", "commitId": "734713bc0" }

Rename branch renameBranch

PUT

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Changes a branch's name

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Request Body

json
branchName *: string
Name of the new branch name

Response

Successful operation.

Delete branch deleteBranch

DELETE

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Deletes a branch

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

Operation completed successfully with no content returned.

List branch commits listBranchCommits

GET

Try it out

Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Returns the list of commits for a project branch

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Query Parameters

offset: number
Obtains paginated results with provided offset
limit: number
Limits the amount of commits retrieved

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

json
Successful operation.
items: array
Array items
Examples
application/json
[ { "id": "id", "message": "commit message", "authorName": "test", "authorEmail": "test@mulesoft.com", "committerName": "test", "committerEmail": "test@mulesoft.com", "dateCreated": 1601480399000 } ]

Merge branch mergeBranch

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Merge this branch with a source branch

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Request Body

json
sourceBranch *: string
squashCommits: boolean
commitMessage: string
conflictsResolutionStrategy: string

Response

Successful operation.

Get branch conformance report getBranchConformance

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Returns conformance report for the latest published version

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Header Parameters

authorization *: string
Bearer Access Token

Response

Report returned successfully

Get branch conformance plan getBranchConformancePlan

GET

Try it out

Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Returns conformance plan for the latest published version

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Query Parameters

criteria: string
Criteria to consider when calculating the conformance plan

Header Parameters

authorization *: string
Bearer Access Token

Response

Report returned successfully

Report branch event to metrics service reportBranchEvent

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Report event to MDAS Metrics service

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Header Parameters

authorization *: string
Bearer Access Token

Request Body

json
id *: string
payload *: object

Response

Successful operation.

Open branch and list project files openBranch

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
List project files. If user's workingDir does not exists, it creates one.

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

json
Successful operation.
items: array
Array items
Examples
application/json
[ { "path": "api.raml", "type": "FILE" }, { "path": "types", "type": "FOLDER" }, { "path": "types/customer.raml", "type": "FILE" }, { "path": "types/person.raml", "type": "FILE" }, { "path": "types/address.raml", "type": "FILE" } ]

Clean uncommitted files from working dir cleanBranch

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
cleans uncommited files from users workingDir

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

Successful operation.

Get branch working directory status getBranchStatus

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
list WorkingDir status

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

Successful operation.

Save branch files saveBranchFiles

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
save listed files (save and save All)

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Request Body

json
items: array
Array items

Response

json
Successful operation.
items: array
Array items
Examples
application/json
[ { "path": "api.raml", "type": "FILE" }, { "path": "types", "type": "FOLDER" }, { "path": "types/customer.raml", "type": "FILE" }, { "path": "types/person.raml", "type": "FILE" }, { "path": "types/address.raml", "type": "FILE" } ]

Save branch files (v2 multipart) saveBranchFilesV2

POST

Try it out

Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body multipart/form-data
Save listed files (save and save All).
Accepts any file as body's content-type can be multipart/form-data

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Query Parameters

metadata: boolean
When true, it retrieves extra file metadata such as lastPublishedVersion

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token
x-if-match: string
etag to check for concurrency conflicts

Request Body

json
items: array
Array items
items: array
Array items

Response

json
Successful operation.
items: array
Array items
Examples
application/json
[ { "path": "api.raml", "type": "FILE" }, { "path": "types", "type": "FOLDER" }, { "path": "types/customer.raml", "type": "FILE" }, { "path": "types/person.raml", "type": "FILE" }, { "path": "types/address.raml", "type": "FILE" } ]

List branch files listBranchFiles

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Gets a list of the structure of the file system (open project)

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

json
Successful operation.
items: array
Array items
Examples
application/json
[ { "path": "api.raml", "type": "FILE" }, { "path": "types", "type": "FOLDER" }, { "path": "types/customer.raml", "type": "FILE" }, { "path": "types/person.raml", "type": "FILE" }, { "path": "types/address.raml", "type": "FILE" } ]

Get branch file content (v2) getBranchFileV2

GET

Try it out

Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Returns the given file (getFile) with content-type according to file's content

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation
filePath *: string
File Path to retrieve. Must be URI complain and escape '/' characters

Query Parameters

local: boolean
When true, reads the file from the local working directory copy instead of the git bare repository

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

Successful operation.

Get branch file as JSON getBranchFile

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Returns the given file (getFile) in application/json format

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation
filePath *: string
File Path to retrieve. Must be URI complain and escape '/' characters

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

Successful operation.

Delete branch file or folder deleteBranchFile

DELETE

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Deletes the given file or folder and commit changes (deleteFile)

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation
filePath *: string
File Path to retrieve. Must be URI complain and escape '/' characters

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

Operation completed successfully with no content returned.

Move or rename branch file moveBranchFile

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
renames the file or folder (move or rename)

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation
filePath *: string
File Path to retrieve. Must be URI complain and escape '/' characters

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Request Body

json
path *: string
type: string

Response

File was moved successfully

Acquire branch lock acquireBranchLock

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Acquire lock for given project

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Request Body

json

Response

json
Successful operation.
locked *: boolean
True when the user has the lock, otherwise false.
name: string
Name of the user
Examples
application/json
{ "locked": true, "name": "demo-username" }

Release branch lock releaseBranchLock

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Release lock for given project

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Request Body

json

Response

Successful operation.

Keep branch lock alive renewBranchLock

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Mantain lock for given project

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Request Body

json

Response

Successful operation.

Publish branch to Exchange publishBranchToExchange

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Publish project to Exchange. As a result, an Exchange asset is created.

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Request Body

json

Response

Successful operation.

Get branch Exchange metadata getBranchExchangeMetadata

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieve Exchange metadata for a project's branch

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

Successful operation.

Publish Exchange asset via xAPI v2 publishBranchAssetV2

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Publish new Exchange Asset through Exchange xAPI v2

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Request Body

json
groupId *: string
Business group where the Exchange asset will be published
assetId *: string
ID that will identify the asset in Exchange
version *: string
Version that will identify the asset in Exchange
name: string
The visible name of the asset. Default to the project name
classifier *: string
Classifier of the asset
description: string
The description of the asset being created
type: string
The type of the asset to be created, if none has been specified it will be inferred by the file's classifier
dependencies: string
keywords: string

Response

Asset created successfully

Replace branch contents from zip archive importBranchArchive

PUT

Try it out

Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/zip
Replaces branch contents from a zip file

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Query Parameters

message: string
Commit message for the import

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token
x-if-match: string
etag to check for concurrency conflicts

Request Body

zip

Response

json
Successful operation.
items: array
Array items
Examples
application/json
[ { "path": "api.raml", "type": "FILE" }, { "path": "types", "type": "FOLDER" }, { "path": "types/customer.raml", "type": "FILE" }, { "path": "types/person.raml", "type": "FILE" }, { "path": "types/address.raml", "type": "FILE" } ]

Download branch archive as zip getBranchArchive

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Gets an archive file (zip) of the full project in the given branch

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

Successful operation.

List Exchange dependencies listExchangeDependencies

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieve the dependencies listed in exchange.json, along with their asset metadata

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

Successful operation.

Update Exchange dependencies updateExchangeDependencies

POST

Try it out

Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates exchange.json file, with given dependencies

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Query Parameters

removeInvalidDependencies: boolean
When true, removes invalid dependencies found while updating exchange.json

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Request Body

json
add *: array
remove *: array

Response

Successful operation.

Add Exchange dependencies addExchangeDependencies

PUT

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Add new dependencies in exchange.json

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Request Body

json
items: array
Array items

Response

json
Successful operation.
items: array
Array items
Examples
application/json
[ { "path": "api.raml", "type": "FILE" }, { "path": "types", "type": "FOLDER" }, { "path": "types/customer.raml", "type": "FILE" }, { "path": "types/person.raml", "type": "FILE" }, { "path": "types/address.raml", "type": "FILE" } ]

Reload Exchange dependencies metadata reloadExchangeDependencies

PATCH

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Reload and update the dependencies listed in exchange.json

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Request Body

json
add *: array
remove *: array

Response

Successful operation.

Remove Exchange dependencies removeExchangeDependencies

DELETE

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Removes dependencies in exchange.json

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Request Body

json
items: array
Array items

Response

Operation completed successfully with no content returned.

Get dependency resolution job status getExchangeDependenciesJobStatus

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieves the status of the dependency resolution job

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

json
Successful operation.
status: string
Examples
application/json
{ "status": "running" }

Trigger Exchange dependency resolution job resolveExchangeDependencies

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Triggers an asynchronous dependency resolution job for the project's exchange.json

Path Parameters

projectId *: string
branch *: string
Branch name to which apply a given operation

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

Successful operation.

Sync project with Github repository syncProjectGithub

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Sync project with Github repository

Path Parameters

projectId *: string

Request Body

json
domain *: string
Domain value where the repo will be created
domainType *: string
Domain type where the repo will be created, can be in a given user or organization
repositoryName *: string
Name of the repository to be created

Response

Successful operation.

Remove Github repository sync removeGithubSync

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Remove sync with Github repository

Path Parameters

projectId *: string

Response

Successful operation.

Get project permissions getProjectPermissions

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Gets permissions for a project

Path Parameters

projectId *: string

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

json
Successful operation.
projectId *: string
canModify *: boolean
canDelete *: boolean
canRename *: boolean
canPublish: boolean
canShare: boolean
canOwn: boolean
Examples
application/json
{ "projectId": "string", "canModify": true, "canDelete": true, "canRename": true }

List identities with project access listProjectSharedIdentities

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Get the identities (users and teams) with access to the project, along with their granted permission role

Path Parameters

projectId *: string

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

json
Successful operation.
sharedWith *: array

Share or revoke project permissions shareProjectPermissions

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Grants or Revokes permissions on a [user | role] matrix for a project.

Path Parameters

projectId *: string

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Request Body

json
sharedWith: array
Identities to grant (or change) a role on the project
revoked: array
Identities to revoke all access from

Response

json
Successful operation.
sharedWith *: array
revoked *: array
Examples
application/json
{ "sharedWith": [ { "role": "string", "id": "string", "result": "string" } ], "revoked": [ { "role": "string", "id": "string", "result": "string" } ] }

Start Github installation getGithub

GET

Try it out

Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Returns a redirect to start Github installation

Query Parameters

token *: string
Token used to authenticate against github
origin *: string
Origin of the request being made in order to build the redirect URL

Header Parameters

authorization *: string
Bearer Access Token

Response

Redirection response

Handle Github installation callback getGithubCallback

GET

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Endpoint requested after installation by the Github App

Header Parameters

authorization *: string
Bearer Access Token

Response

Successful operation.

Complete Github OAuth authorization completeGithubOauth

POST

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Sends the Github OAuth code and state to VCS to finish the Github OAuth authorization workflow

Header Parameters

authorization *: string
Bearer Access Token

Request Body

json
code *: string
state *: string

Response

Successful operation.

Handle Github OAuth callback getGithubOauthCallback

GET

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
Redirects the response received from Github (code and state query params) back to the Design Center UI

Query Parameters

code: string
Github OAuth authorization code returned by Github after the user grants access.
state: string
Opaque value echoed back by Github, used to correlate this callback with the originating request.

Response

Redirection response

Search Exchange assets searchExchangeAssets

GET

Try it out

Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Searches Exchange assets (RAML fragments, REST APIs, evented APIs) visible to the current user

Query Parameters

visual: boolean
When true, restricts the search to visual designer assets
searchTerm: string
Free-text term to filter Exchange assets by name or description.
businessId: string
Restricts the search to assets belonging to the given business group.
pageOffset: number
Number of assets to skip, used for pagination.
status: string
Restricts the search to assets in the given publish status.

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

Successful operation.

Get Exchange asset metadata getExchangeAssetMetadata

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Returns Exchange asset metadata

Path Parameters

groupId *: string
Exchange group identifier that owns the asset, typically the organization id.
assetId *: string
Exchange asset identifier of the asset to retrieve metadata for.
version *: string
Version of the Exchange asset to retrieve metadata for.

Header Parameters

authorization *: string
Bearer Access Token

Response

Successful operation.

Execute Exchange GraphQL query executeExchangeGraphql

POST

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Executes GQL queries against exchange GraphQL service

Header Parameters

authorization *: string
Bearer Access Token

Request Body

json

Response

Successful operation.

Check external repository access checkExternalAccess

GET

Try it out

Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Checks if the provided user has access to the provided git repository type

Query Parameters

vcsStorageType: string

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

json
Successful operation.
is_token_authorized: boolean

List external repositories listExternalRepositories

GET

Try it out

Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieves external repositories associated with the provided user and organization

Query Parameters

vcsStorageType: string
page: number
Page number to retrieve, used for pagination.
externalOrg: string
Name of the external git organization to list repositories from.
externalOrgType: string
Type of the external git organization (e.g. user or organization account).
name: string
Search term to filter repositories by name.

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

json
Successful operation.
items: array
Array items

Get external repository by ID getExternalRepositoryById

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieves metadata of the repository represented with the provided ID

Path Parameters

repositoryId *: string
ID of the repository to retrieve

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

json
Successful operation.
name *: string
owner *: object
private *: boolean
imported *: boolean
description *: string
Examples
application/json
{ "name": "my-repo", "owner": { "name": "my-org", "type": "Organization" }, "private": false, "imported": false, "description": "An example external repository." }

List external organizations listExternalOrganizations

GET

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Retrieves all external organizations associated with the provided user

Header Parameters

x-owner-id *: string
x-organization-id *: string
authorization *: string
Bearer Access Token

Response

json
Successful operation.
items: array
Array items