Snapvisor Docs
API ReferenceProjects

Get a project

Retrieve a project by its owner (account slug) and project name. Use it when you need a project's details or settings, for example before changing them.

GET
/projects/{owner}/{project}

Retrieve a project by its owner (account slug) and project name. Use it when you need a project's details or settings, for example before changing them.

Authorization

AuthorizationBearer <token>

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 Snapvisor project settings. Project tokens are used by CI and the SDK to create builds and deployments.

In: header

Path Parameters

owner*string
Length1 <= length
project*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/projects/string/string"
{  "id": "string",  "account": {    "id": "string",    "slug": "string"  },  "name": "string",  "defaultBaseBranch": "string",  "hasRemoteContentAccess": true,  "autoApprovedBranchGlob": "string",  "deploymentProductionBranchGlob": "string",  "private": true,  "summaryCheck": "always",  "prCommentEnabled": true,  "githubActionsOidcEnabled": true,  "tokenlessAuthEnabled": true,  "deploymentEnabled": true,  "deploymentAuth": "public",  "defaultUserLevel": "admin",  "ignoreConfig": {    "enabled": true,    "autoIgnore": {      "changes": 1    }  }}

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. Use it when the user wants to start visual testing for a new app or repository.

Update a project PATCH

Update a project's settings. Only the fields present in the request are changed. Requires administrator access to the project. Use it when a project administrator asks to change a project's settings.