Skip to content
deploybase

Detect a repository's framework

GET
/teams/{teamId}/github/repos/{owner}/{repo}/detect
 
curl --request GET \
  --url https://api.deploybase.eu/api/v1/teams/example/github/repos/example/example/detect

Runs the same detection rules as POST /projects/detect over the repository, through the GitHub API. framework, package_manager and signals are the original advisory fields (framework: null when unsure); settings and checks are the full answer with a source for every value.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
teamId
required
string

Team UUID

owner
required
string

Repository owner

repo
required
string

Repository name

Query Parameters

Section titled “ Query Parameters ”
ref
string

Branch, tag or SHA (defaults to the repo’s default branch)

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

OK

Media type application/json
object
data
meta
object
request_id
string
timestamp
string
trace_id
string

Example generated

{
  "data": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

403

Section titled “ 403 ”

Forbidden

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string

Example generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

404

Section titled “ 404 ”

Repository not found

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string

Example generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

409

Section titled “ 409 ”

No GitHub App connection

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string

Example generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

Live a8b7eb1d built