Travis CI API Docs

Repository

An individual repository.

If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.

Attributes

Minimal Representation

Included when the resource is returned as part of another resource.

NameTypeDescription
idIntegerValue uniquely identifying the repository.
nameStringThe repository's name on GitHub.
slugStringSame as {repository.owner.name}/{repository.name}.

Standard Representation

Included when the resource is the main response of a request, or is eager loaded.

NameTypeDescription
idIntegerValue uniquely identifying the repository.
nameStringThe repository's name on GitHub.
slugStringSame as {repository.owner.name}/{repository.name}.
descriptionStringThe repository's description from GitHub.
github_idIntegerThe repository's id on GitHub.
vcs_idUnknownThe repository's vcs_id.
vcs_typeUnknownThe repository's vcs_type.
github_languageStringThe main programming language used according to GitHub.
activeBooleanWhether or not this repository is currently enabled on Travis CI.
privateBooleanWhether or not this repository is private.
ownerOwnerGitHub user or organization the repository belongs to.
owner_nameUnknownThe repository's owner_name.
vcs_nameUnknownThe repository's vcs_name.
default_branchBranchThe default branch on GitHub.
starredBooleanWhether or not this repository is starred.
managed_by_installationBooleanWhether or not this repository is managed by a GitHub App installation.
active_on_orgBooleanWhether or not this repository runs builds on travis-ci.org (may also be null).
migration_statusUnknownThe repository's migration_status.
history_migration_statusUnknownThe repository's history_migration_status.
sharedUnknownThe repository's shared.
config_validationUnknownThe repository's config_validation.
server_typeUnknownThe repository's server_type.
scan_failed_atUnknownThe repository's scan_failed_at.

List Representation

Document representations/list not found.

NameTypeDescription
idIntegerValue uniquely identifying the repository.
nameStringThe repository's name on GitHub.
slugStringSame as {repository.owner.name}/{repository.name}.
activeBooleanWhether or not this repository is currently enabled on Travis CI.
privateBooleanWhether or not this repository is private.
ownerOwnerGitHub user or organization the repository belongs to.
vcs_idUnknownThe repository's vcs_id.
vcs_typeUnknownThe repository's vcs_type.
server_typeUnknownThe repository's server_type.

Minimal_with_build Representation

Document representations/minimal_with_build not found.

NameTypeDescription
idIntegerValue uniquely identifying the repository.
nameStringThe repository's name on GitHub.
slugStringSame as {repository.owner.name}/{repository.name}.
activeBooleanWhether or not this repository is currently enabled on Travis CI.
privateBooleanWhether or not this repository is private.
ownerOwnerGitHub user or organization the repository belongs to.
vcs_idUnknownThe repository's vcs_id.
vcs_typeUnknownThe repository's vcs_type.
server_typeUnknownThe repository's server_type.
managed_by_installationBooleanWhether or not this repository is managed by a GitHub App installation.
last_started_buildBuildAlias for current_build.
current_buildBuildThe most recently started build (this excludes builds that have been created but have not yet started).

Additional Attributes

NameTypeDescription
allow_migrationUnknownThe repository's allow_migration.

Actions

Find

This returns an individual repository.

GET
/repo/{provider}/{repository.id}
Template VariableTypeDescription
providerUnknownDocumentation missing.
repository.idIntegerValue uniquely identifying the repository.
Query ParameterTypeDescription
include[String]List of attributes to eager load.
repository.server_typeUnknownThe repository's server_type.
server_typeUnknownAlias for repository.server_type.
GET
/repo/{provider}/{repository.slug}
Template VariableTypeDescription
providerUnknownDocumentation missing.
repository.slugStringSame as {repository.owner.name}/{repository.name}.
Query ParameterTypeDescription
include[String]List of attributes to eager load.
repository.server_typeUnknownThe repository's server_type.
server_typeUnknownAlias for repository.server_type.
GET
/repo/{repository.id}
Template VariableTypeDescription
repository.idIntegerValue uniquely identifying the repository.
Query ParameterTypeDescription
include[String]List of attributes to eager load.
repository.server_typeUnknownThe repository's server_type.
server_typeUnknownAlias for repository.server_type.

Example:GET /repo/891

GET
/repo/{repository.slug}
Template VariableTypeDescription
repository.slugStringSame as {repository.owner.name}/{repository.name}.
Query ParameterTypeDescription
include[String]List of attributes to eager load.
repository.server_typeUnknownThe repository's server_type.
server_typeUnknownAlias for repository.server_type.

Example:GET /repo/rails%2Frails

Activate

This will activate a repository, allowing its tests to be run on Travis CI.

POST
/repo/{provider}/{repository.id}/activate
Template VariableTypeDescription
providerUnknownDocumentation missing.
repository.idIntegerValue uniquely identifying the repository.
POST
/repo/{provider}/{repository.slug}/activate
Template VariableTypeDescription
providerUnknownDocumentation missing.
repository.slugStringSame as {repository.owner.name}/{repository.name}.
POST
/repo/{repository.id}/activate
Template VariableTypeDescription
repository.idIntegerValue uniquely identifying the repository.

Example:POST /repo/891/activate

POST
/repo/{repository.slug}/activate
Template VariableTypeDescription
repository.slugStringSame as {repository.owner.name}/{repository.name}.

Example:POST /repo/rails%2Frails/activate

Deactivate

This will deactivate a repository, preventing any tests from running on Travis CI.

POST
/repo/{provider}/{repository.id}/deactivate
Template VariableTypeDescription
providerUnknownDocumentation missing.
repository.idIntegerValue uniquely identifying the repository.
POST
/repo/{provider}/{repository.slug}/deactivate
Template VariableTypeDescription
providerUnknownDocumentation missing.
repository.slugStringSame as {repository.owner.name}/{repository.name}.
POST
/repo/{repository.id}/deactivate
Template VariableTypeDescription
repository.idIntegerValue uniquely identifying the repository.

Example:POST /repo/891/deactivate

POST
/repo/{repository.slug}/deactivate
Template VariableTypeDescription
repository.slugStringSame as {repository.owner.name}/{repository.name}.

Example:POST /repo/rails%2Frails/deactivate

Star

This will star a repository based on the currently logged in user.

POST
/repo/{provider}/{repository.id}/star
Template VariableTypeDescription
providerUnknownDocumentation missing.
repository.idIntegerValue uniquely identifying the repository.
POST
/repo/{provider}/{repository.slug}/star
Template VariableTypeDescription
providerUnknownDocumentation missing.
repository.slugStringSame as {repository.owner.name}/{repository.name}.
POST
/repo/{repository.id}/star
Template VariableTypeDescription
repository.idIntegerValue uniquely identifying the repository.

Example:POST /repo/891/star

POST
/repo/{repository.slug}/star
Template VariableTypeDescription
repository.slugStringSame as {repository.owner.name}/{repository.name}.

Example:POST /repo/rails%2Frails/star

Unstar

This will unstar a repository based on the currently logged in user.

POST
/repo/{provider}/{repository.id}/unstar
Template VariableTypeDescription
providerUnknownDocumentation missing.
repository.idIntegerValue uniquely identifying the repository.
POST
/repo/{provider}/{repository.slug}/unstar
Template VariableTypeDescription
providerUnknownDocumentation missing.
repository.slugStringSame as {repository.owner.name}/{repository.name}.
POST
/repo/{repository.id}/unstar
Template VariableTypeDescription
repository.idIntegerValue uniquely identifying the repository.

Example:POST /repo/891/unstar

POST
/repo/{repository.slug}/unstar
Template VariableTypeDescription
repository.slugStringSame as {repository.owner.name}/{repository.name}.

Example:POST /repo/rails%2Frails/unstar