API Designer Experience API

1.0.0

Overview

Statistics
35 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

Get Ping getPing

GET

Try it out

Custom Query Parameters
Custom Headers
to check if service is up

Response

Successful operation.

Get Status getStatus

GET

Try it out

Custom Query Parameters
Custom Headers
to check if service is up

Response

Successful operation.

Get Projects getProjects

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 Projects createProjects

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
format: string
classifier: string
type *: string
Project type

Response

json
Resource created successfully.
organizationId *: string
id *: string
name *: string
Project name
description: string
Project description
type *: string
Project type
vcsType *: string
VCS Project type
createdBy *: string
Name of the user that created the project
createdDate *: integer(long)
Creation date of the project
Examples
application/json
{ "organizationId": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22", "id": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22", "name": "string", "description": "string", "type": "string", "vcsType": "string", "createdBy": "string", "createdDate": 0 }

Create Projects Import createProjectsImport

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
type *: string
mainFile: string
zipFile *: string(binary)
dependencies: string

Response

json
Resource created successfully.
organizationId *: string
id *: string
name *: string
Project name
description: string
Project description
type *: string
Project type
vcsType *: string
VCS Project type
createdBy *: string
Name of the user that created the project
createdDate *: integer(long)
Creation date of the project
Examples
application/json
{ "organizationId": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22", "id": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22", "name": "string", "description": "string", "type": "string", "vcsType": "string", "createdBy": "string", "createdDate": 0 }

Get Projects By Projectid getProjectsByProjectid

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
vcsType *: string
VCS Project type
createdBy *: string
Name of the user that created the project
createdDate *: integer(long)
Creation date of the project
Examples
application/json
{ "organizationId": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22", "id": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22", "name": "string", "description": "string", "type": "string", "vcsType": "string", "createdBy": "string", "createdDate": 0 }

Patch Projects By Projectid patchProjectsByProjectid

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
vcsType *: string
VCS Project type
createdBy *: string
Name of the user that created the project
createdDate *: integer(long)
Creation date of the project
Examples
application/json
{ "organizationId": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22", "id": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22", "name": "string", "description": "string", "type": "string", "vcsType": "string", "createdBy": "string", "createdDate": 0 }

Delete Projects By Projectid deleteProjectsByProjectid

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.

Get Projects By Projectid Branches getProjectsByProjectidBranches

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
List branches

Path Parameters

projectId *: string

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 Projects By Projectid Branches createProjectsByProjectidBranches

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

Response

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

Delete Projects By Projectid Branches By Branch deleteProjectsByProjectidBranchesByBranch

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.

Create Projects By Projectid Branches By Branch Open createProjectsByProjectidBranchesByBranchOpen

POST

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" } ]

Create Projects By Projectid Branches By Branch Clean createProjectsByProjectidBranchesByBranchClean

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 Projects By Projectid Branches By Branch Status getProjectsByProjectidBranchesByBranchStatus

GET

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.

Create Projects By Projectid Branches By Branch Save createProjectsByProjectidBranchesByBranchSave

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" } ]

Create Projects By Projectid Branches By Branch Save V2 createProjectsByProjectidBranchesByBranchSaveV2

POST

Try it out

Path 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

Header Parameters

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

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" } ]

Get Projects By Projectid Branches By Branch Files getProjectsByProjectidBranchesByBranchFiles

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 Projects By Projectid Branches By Branch Files V2By Filepath getProjectsByProjectidBranchesByBranchFilesV2ByFilepath

GET

Try it out

Path 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

Header Parameters

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

Response

Successful operation.

Get Projects By Projectid Branches By Branch Files By Filepath getProjectsByProjectidBranchesByBranchFilesByFilepath

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 Projects By Projectid Branches By Branch Files By Filepath deleteProjectsByProjectidBranchesByBranchFilesByFilepath

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.

Create Projects By Projectid Branches By Branch Files By Filepath Move createProjectsByProjectidBranchesByBranchFilesByFilepathMove

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

Create Projects By Projectid Branches By Branch Acquirelock createProjectsByProjectidBranchesByBranchAcquirelock

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" }

Create Projects By Projectid Branches By Branch Releaselock createProjectsByProjectidBranchesByBranchReleaselock

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.

Create Projects By Projectid Branches By Branch Publish Platform createProjectsByProjectidBranchesByBranchPublishPlatform

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Publish project to Api Platform

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.

Create Projects By Projectid Branches By Branch Publish Exchange createProjectsByProjectidBranchesByBranchPublishExchange

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
name *: string
Project name
apiVersion *: string
Version of the API, which corresponds to the specification's version property
version *: string
Version of the Exchange Asset to be published (must follow Semver syntax)
tags *: array
An array of strings to be saved as asset's tags
main *: string
Main file of the project to be published
assetId *: string
Exchange Asset ID
groupId *: string
classifier *: string
Classifier of the project being published which is related to the asset's language
isVisual *: boolean
True when the project is visual mode
metadata: object
A design center object describing asset projectId and branchId
publishList: array
Project files that are not being referenced from the root file to include in the asset
originalFormatVersion: string
The version of the format of the API specification
status *: string
Exchange asset lifecycle state

Response

json
Successful operation.
organizationId *: string
groupId *: string
assetId *: string
AssetID of the published asset
version *: string
Asset version of the published asset
apiVersion *: string
The API version of the API specification
dependencies *: array
All the project dependencies included in the publication
main *: string
The main file of the asset
versionGroup *: string
The Exchange asset version group
classifier *: string
The language identifier of the asset to be created
metadata *: object
A design center object describing the projectId and branchId of the published project
originalFormatVersion *: string
The version of the format of the API specification
name *: string
The visible name of the asset
type *: string
Type of the created asset
Examples
application/json
{ "organizationId": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22", "groupId": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22", "assetId": "new-raml-specification", "version": "1.0.0", "apiVersion": "v1", "dependencies": [ "string" ], "main": "api.raml", "versionGroup": "v1", "classifier": "raml", "metadata": {} }

Create Projects By Projectid Branches By Branch Exchange Dependencies createProjectsByProjectidBranchesByBranchExchangeDependencies

POST

Try it out

Path 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

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.

Update Projects By Projectid Branches By Branch Exchange Dependencies updateProjectsByProjectidBranchesByBranchExchangeDependencies

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" } ]

Delete Projects By Projectid Branches By Branch Exchange Dependencies deleteProjectsByProjectidBranchesByBranchExchangeDependencies

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 Projects By Projectid Api By Name getProjectsByProjectidApiByName

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Get api data, from Api Platform, for given {name}

Path Parameters

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

Response

Successful operation.

Create Projects By Projectid Api By Name By Version createProjectsByProjectidApiByNameByVersion

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Publish project to Api Platform (Deprecated)

Path Parameters

projectId *: string
name *: string
The name to identify the target resource.
version *: string
The version to identify the target resource.

Response

Successful operation.

Create Projects By Projectid Sync Github createProjectsByProjectidSyncGithub

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
name *: string
description *: string
type *: string
mainFile: string
zipFile *: string(binary)
dependencies: string

Response

Successful operation.

Delete Projects By Projectid Sync Github deleteProjectsByProjectidSyncGithub

DELETE

Try it out

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

Path Parameters

projectId *: string

Response

Successful operation.

Get Projects By Projectid Access Permissions getProjectsByProjectidAccessPermissions

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
Examples
application/json
{ "projectId": "string", "canModify": true, "canDelete": true, "canRename": true }

Create Projects By Projectid Access Permissions Share createProjectsByProjectidAccessPermissionsShare

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
revoke *: array
previousSharedWith *: array

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" } ] }

Create Exchange Graphql createExchangeGraphql

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.