Skip to content

Projects API

Project endpoints gestionan marketplace integrations: metadata, visibility/access level, links y uploaded icon/cover images.

GET /api/v2/projects

Devuelve lista de projects disponibles para current account.

Arguments:

ArgumentLocationDescription
workspaceQueryOptional workspace fullname filter.
scopeQueryOptional scope: all, marketplace, backend.

Payload: ninguno.

Respuesta: ProjectView[].

GET /api/v2/projects/create-capability

Comprueba si current account/workspace puede crear project.

Arguments: ninguno.

Payload: ninguno.

Respuesta: ProjectCreateCapability.

GET /api/v2/projects/:fullname

Devuelve project por fullname.

Arguments:

ArgumentLocationDescription
fullnamePathProject fullname.

Payload: ninguno.

Respuesta: ProjectView.

PUT /api/v2/projects/:fullname

Crea o actualiza project.

Arguments:

ArgumentLocationDescription
fullnamePathProject fullname. Debe coincidir con payload.fullname.

Payload:

FieldRequiredDescription
nameProject name dentro de workspace.
fullnameFullname en formato <workspace>.<name>.
workspaceWorkspace fullname.
publicLegacy public flag. Para código nuevo, es mejor pasar también accessLevel.
visibilityNoStorage visibility: public, private_link, personal.
accessLevelNoProduct access level: private, public, free.
tagsNoProject tags.
labelsNoProject labels.
meta.titleTítulo visible del project.
meta.descriptionDescripción completa.
meta.shortDescriptionNoDescripción corta.
meta.linksNoArray de { title, url } useful links.
meta.iconNoIcon URL. Puede ser uploaded asset URL.
meta.avatarNoAvatar URL. Normalmente coincide con icon.
meta.coverNoCover URL. Puede ser uploaded asset URL.

Respuesta: ProjectView.

DELETE /api/v2/projects/:fullname

Elimina project.

Arguments:

ArgumentLocationDescription
fullnamePathProject fullname.

Payload: ninguno.

Respuesta: OperationResult.

Abre private project por access link.

Arguments:

ArgumentLocationDescription
tokenPathAccess link token.

Payload: ninguno.

Respuesta: ProjectView.

POST /api/v2/projects/:fullname/access-links

Crea access link para private project.

Arguments:

ArgumentLocationDescription
fullnamePathProject fullname.

Payload:

FieldRequiredDescription
maxUsagesNoMaximum link usages.
expiresAtNoExpiration date-time.

Respuesta: ProjectAccessLink.

POST /api/v2/projects/:fullname/assets/images

Sube project image para icon o cover.

Arguments:

ArgumentLocationDescription
fullnamePathProject fullname.

Payload:

FieldRequiredDescription
filenameOriginal filename.
contentTypeMIME type de la imagen.
dataBase64 image data.
targeticon o cover.

Respuesta: ProjectImageUploadResult. Este URL se pasa después en meta.icon o meta.cover al guardar project.

DELETE /api/v2/projects/:fullname/images/:asset

Elimina uploaded project image.

Arguments:

ArgumentLocationDescription
fullnamePathProject fullname.
assetPathAsset filename, por ejemplo icon.png o draft asset name.

Payload: ninguno.

Respuesta: OperationResult.