Projects

Retrieve project metadata, either by slug or for the project tied to the current token.

Get the current project

get

Retrieve the project associated with the project token used to authenticate the request.

Authorizations

projectToken

AuthorizationstringRequired

Authenticate as a project with a project token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <project-token>

You can find your project token in your Argos project settings. Project tokens are used by CI and the SDK to create builds and deployments.

Responses

200

Project

application/json

Project

idstringRequired

namestring · min: 1Required

defaultBaseBranchstringRequired

hasRemoteContentAccessbooleanRequired

401

Unauthorized

application/json

500

Server error

application/json

get/project

HTTPcURLJavaScriptPython

GET /v2/project HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "account": {
    "id": "text",
    "slug": "text"
  },
  "name": "text",
  "defaultBaseBranch": "text",
  "hasRemoteContentAccess": true
}

Create a project

post

Create a new project in an account you administer. The authenticated personal access token must be scoped to the target account, and the acting user must be an administrator of it.

Authorizations

personalAccessToken

AuthorizationstringRequired

Authenticate as a user with a personal access token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <personal-access-token>

Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.

Body

application/json

namestring · min: 1 · max: 100Required

Name of the project to create. Must be unique within the account (case-insensitive) and cannot be a reserved name.

Pattern: ^[a-zA-Z0-9_\-.]+$

accountSlugstring · min: 1Required

Slug of the account (personal or team) that will own the project. The personal access token must be scoped to this account and the acting user must be one of its administrators.

Responses

201

Project created successfully — returns the project

application/json

Project

idstringRequired

namestring · min: 1Required

defaultBaseBranchstringRequired

hasRemoteContentAccessbooleanRequired

400

Invalid parameters

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server error

application/json

post/projects

HTTPcURLJavaScriptPython

POST /v2/projects HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "text",
  "accountSlug": "text"
}

{
  "id": "text",
  "account": {
    "id": "text",
    "slug": "text"
  },
  "name": "text",
  "defaultBaseBranch": "text",
  "hasRemoteContentAccess": true
}

Get a project

get

Retrieve a project by its owner (account slug) and project name.

Authorizations

projectTokenpersonalAccessToken

AuthorizationstringRequired

Authenticate as a project with a project token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <project-token>

You can find your project token in your Argos project settings. Project tokens are used by CI and the SDK to create builds and deployments.

Path parameters

ownerstring · min: 1Required

projectstring · min: 1Required

Responses

200

Project

application/json

Project

idstringRequired

namestring · min: 1Required

defaultBaseBranchstringRequired

hasRemoteContentAccessbooleanRequired

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Server error

application/json

get/projects/{owner}/{project}

HTTPcURLJavaScriptPython

GET /v2/projects/{owner}/{project} HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "account": {
    "id": "text",
    "slug": "text"
  },
  "name": "text",
  "defaultBaseBranch": "text",
  "hasRemoteContentAccess": true
}