Create project
POST
/api/projectsSigned-in member
Request body
application/json
| Field | Type | Required | Notes |
|---|---|---|---|
name | string | Required | max 120 |
Response
Success: 201
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Optional | |
name | string | Optional | |
createdAt | string (date-time) | Optional | |
sources | array of IntegrationSourceView | Optional | |
sources[].id | string (uuid) | Optional | |
sources[].type | enum SourceType | Optional | GITHUBGITLABLINEARJIRA |
sources[].deliveryMechanism | string | Optional | |
sources[].externalProjectKey | string | Optional | |
sources[].externalTeamKey | string | Optional | |
sources[].owner | string | Optional | |
sources[].repository | string | Optional | |
sources[].apiBaseUrl | string | Optional | |
sources[].externalWorkspaceKey | string | Optional | |
sources[].credentialIdentity | string | Optional | |
sources[].webhookAuthMode | enum WebhookAuthMode | Optional | GITHUB_HMACGITLAB_SIGNING_TOKENGITLAB_SECRET_TOKENLINEAR_HMACNONE |
sources[].webhookId | string (uuid) | Optional | |
sources[].webhookPath | string | Optional | |
sources[].createdAt | string (date-time) | Optional | |
sources[].lastDeliveryAt | string (date-time) | Optional | |
sources[].accessTokenConfigured | boolean | Optional | |
sources[].accessTokenUpdatedAt | string (date-time) | Optional | |
sources[].connectionStatus | enum ConnectionStatus | Optional | ACTIVEERRORDISCONNECTED |
sources[].lastSyncAt | string (date-time) | Optional | |
sources[].lastErrorCode | string | Optional | |
sources[].nextPollAt | string (date-time) | Optional | |
sources[].health | SourceHealth | Optional |
Errors
| Status | Code | Applies to |
|---|---|---|
400 | validation_faileda field is missing or out of range | Any endpoint |
400 | malformed_requestthe body cannot be read | Any endpoint |
400 | invalid_parametera path or query parameter is missing or does not convert, such as an ID that is not a UUID | Any endpoint |
401 | authentication_requiredno session | Any endpoint |
403 | access_deniedan administrator endpoint, or a missing or stale CSRF token | Any endpoint |
404 | not_foundno such address | Any endpoint |
405 | method_not_allowedthe address does not take that method | Any endpoint |
415 | unsupported_media_typethe address does not read a body of that type | Any endpoint |
500 | internal_errora fault ReleaseFlow did not foresee; the body never carries the exception behind it | Any endpoint |
400 | gitlab_base_url_invalid | Sources area |
400 | gitlab_host_not_allowed | Sources area |
400 | jira_site_invalid | Sources area |
400 | github_token_rejected | Sources area |
400 | gitlab_token_rejected | Sources area |
400 | linear_token_rejected | Sources area |
400 | jira_token_rejected | Sources area |
400 | source_credential_required | Sources area |
400 | source_signing_token_invalid | Sources area |
404 | project_not_found | Sources area |
404 | source_not_found | Sources area |
409 | github_repository_already_connected | Sources area |
409 | gitlab_project_already_connected | Sources area |
409 | linear_team_already_connected | Sources area |
409 | jira_project_already_connected | Sources area |
409 | source_token_missing | Sources area |
409 | source_sync_in_progress | Sources area |
409 | source_import_not_supported | Sources area |
409 | source_import_not_resumable | Sources area |
409 | source_disconnected | Sources area |
409 | source_not_disconnected | Sources area |
409 | source_reconnect_required | Sources area |
409 | source_has_no_webhook | Sources area |
409 | source_secret_generated | Sources area |
409 | source_secret_pasted | Sources area |
503 | github_unavailable | Sources area |
503 | gitlab_unavailable | Sources area |
503 | jira_unavailable | Sources area |
Request
bash
# Sign in first and keep the session cookie in cookies.txt (see Sessions and CSRF).
# CSRF_HEADER and CSRF_TOKEN are the headerName and token GET /api/csrf returned.
curl -X POST "http://localhost:8080/api/projects" \
-b cookies.txt -c cookies.txt \
-H "$CSRF_HEADER: $CSRF_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"name": "<string>"
}'
The request body is an example built from the schema; replace every placeholder.
Response
201Example
{
"id": "<uuid>",
"name": "<string>",
"createdAt": "<date-time>",
"sources": [
{
"id": "<uuid>",
"type": "GITHUB",
"deliveryMechanism": "<string>",
"externalProjectKey": "<string>",
"externalTeamKey": "<string>",
"owner": "<string>",
"repository": "<string>",
"apiBaseUrl": "<string>",
"externalWorkspaceKey": "<string>",
"credentialIdentity": "<string>",
"webhookAuthMode": "GITHUB_HMAC",
"webhookId": "<uuid>",
"webhookPath": "<string>",
"createdAt": "<date-time>",
"lastDeliveryAt": "<date-time>",
"accessTokenConfigured": false,
"accessTokenUpdatedAt": "<date-time>",
"connectionStatus": "ACTIVE",
"lastSyncAt": "<date-time>",
"lastErrorCode": "<string>",
"nextPollAt": "<date-time>",
"health": {
"connected": false,
"disconnectedAt": "<date-time>",
"secretUpdatedAt": "<date-time>",
"signatureFailureCount": 0,
"lastSignatureFailureAt": "<date-time>",
"quiet": false,
"quietSince": "<date-time>",
"usualGapHours": 0,
"overdue": false
}
}
]
}