Skip to content

Redocly Scout agent (1.0)

Scout Worker API.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://github.com/Redocly/redocly
Redocly Support
team@redocly.com
License
Redocly
Terms of Service
Languages
Servers
Mock server
https://redocly.com/_mock/docs/realm/scout/agent-api/openapi/
https://redocly.com/{host}/

Health

Operations related to health checks.

Operations

Webhooks

Operations related to incoming git webhooks.

Operations

Create GitHub webhook event

Request

Registers and start process GitHub repository event. For now only push and create pull request events are supported.

Security
GithubApiKey
Bodyapplication/jsonrequired
One of:
object push Recursive 
curl -i -X POST \
  https://redocly.com/_mock/docs/realm/scout/agent-api/openapi/webhooks/github \
  -H 'Content-Type: application/json' \
  -H 'x-hub-signature-256: YOUR_API_KEY_HERE' \
  -d '{
    "ref": "string",
    "before": "string",
    "after": "string",
    "created": true,
    "deleted": true,
    "forced": true,
    "base_ref": "string",
    "compare": "string",
    "commits": [
      {
        "id": "string",
        "tree_id": "string",
        "distinct": true,
        "message": "string",
        "timestamp": "2019-08-24T14:15:22Z",
        "url": "http://example.com",
        "author": {
          "name": "string",
          "email": "user@example.com",
          "date": "2019-08-24T14:15:22Z",
          "username": "string"
        },
        "committer": {
          "name": "string",
          "email": "user@example.com",
          "date": "2019-08-24T14:15:22Z",
          "username": "string"
        },
        "added": [
          "string"
        ],
        "modified": [
          "string"
        ],
        "removed": [
          "string"
        ]
      }
    ],
    "head_commit": {
      "id": "string",
      "tree_id": "string",
      "distinct": true,
      "message": "string",
      "timestamp": "2019-08-24T14:15:22Z",
      "url": "http://example.com",
      "author": {
        "name": "string",
        "email": "user@example.com",
        "date": "2019-08-24T14:15:22Z",
        "username": "string"
      },
      "committer": {
        "name": "string",
        "email": "user@example.com",
        "date": "2019-08-24T14:15:22Z",
        "username": "string"
      },
      "added": [
        "string"
      ],
      "modified": [
        "string"
      ],
      "removed": [
        "string"
      ]
    },
    "repository": {
      "id": 0,
      "node_id": "string",
      "name": "string",
      "full_name": "string",
      "private": true,
      "owner": {
        "login": "string",
        "id": 0,
        "node_id": "string",
        "name": "string",
        "email": "string",
        "avatar_url": "http://example.com",
        "gravatar_id": "string",
        "url": "http://example.com",
        "html_url": "http://example.com",
        "followers_url": "http://example.com",
        "following_url": "http://example.com/{endpoint}",
        "gists_url": "http://example.com/{endpoint}",
        "starred_url": "http://example.com/{endpoint}",
        "subscriptions_url": "http://example.com",
        "organizations_url": "http://example.com",
        "repos_url": "http://example.com",
        "events_url": "http://example.com/{endpoint}",
        "received_events_url": "http://example.com",
        "type": "Bot",
        "site_admin": true
      },
      "html_url": "http://example.com",
      "description": "string",
      "fork": true,
      "url": "http://example.com",
      "forks_url": "http://example.com",
      "keys_url": "http://example.com/{endpoint}",
      "collaborators_url": "http://example.com/{endpoint}",
      "teams_url": "http://example.com",
      "hooks_url": "http://example.com",
      "issue_events_url": "http://example.com/{endpoint}",
      "events_url": "http://example.com",
      "assignees_url": "http://example.com/{endpoint}",
      "branches_url": "http://example.com/{endpoint}",
      "tags_url": "http://example.com",
      "blobs_url": "http://example.com/{endpoint}",
      "git_tags_url": "http://example.com/{endpoint}",
      "git_refs_url": "http://example.com/{endpoint}",
      "trees_url": "http://example.com/{endpoint}",
      "statuses_url": "http://example.com/{endpoint}",
      "languages_url": "http://example.com",
      "stargazers_url": "http://example.com",
      "contributors_url": "http://example.com",
      "subscribers_url": "http://example.com",
      "subscription_url": "http://example.com",
      "commits_url": "http://example.com/{endpoint}",
      "git_commits_url": "http://example.com/{endpoint}",
      "comments_url": "http://example.com/{endpoint}",
      "issue_comment_url": "http://example.com/{endpoint}",
      "contents_url": "http://example.com/{endpoint}",
      "compare_url": "http://example.com/{endpoint}",
      "merges_url": "http://example.com",
      "archive_url": "http://example.com/{endpoint}",
      "downloads_url": "http://example.com",
      "issues_url": "http://example.com/{endpoint}",
      "pulls_url": "http://example.com/{endpoint}",
      "milestones_url": "http://example.com/{endpoint}",
      "notifications_url": "http://example.com/{endpoint}",
      "labels_url": "http://example.com/{endpoint}",
      "releases_url": "http://example.com/{endpoint}",
      "deployments_url": "http://example.com",
      "created_at": 0,
      "updated_at": "2019-08-24T14:15:22Z",
      "pushed_at": 0,
      "git_url": "http://example.com",
      "ssh_url": "string",
      "clone_url": "http://example.com",
      "svn_url": "http://example.com",
      "homepage": "string",
      "size": 0,
      "stargazers_count": 0,
      "watchers_count": 0,
      "language": "string",
      "has_issues": true,
      "has_projects": true,
      "has_downloads": true,
      "has_wiki": true,
      "has_pages": true,
      "forks_count": 0,
      "mirror_url": "http://example.com",
      "archived": false,
      "disabled": true,
      "open_issues_count": 0,
      "license": {
        "key": "string",
        "name": "string",
        "spdx_id": "string",
        "url": "http://example.com",
        "node_id": "string"
      },
      "forks": 0,
      "open_issues": 0,
      "watchers": 0,
      "stargazers": 0,
      "default_branch": "string",
      "allow_squash_merge": true,
      "allow_merge_commit": true,
      "allow_rebase_merge": true,
      "allow_auto_merge": false,
      "allow_forking": true,
      "allow_update_branch": true,
      "use_squash_pr_title_as_default": true,
      "is_template": true,
      "web_commit_signoff_required": true,
      "topics": [
        "string"
      ],
      "visibility": "public",
      "delete_branch_on_merge": false,
      "master_branch": "string",
      "permissions": {
        "pull": true,
        "push": true,
        "admin": true,
        "maintain": true,
        "triage": true
      },
      "public": true,
      "organization": "string"
    },
    "pusher": {
      "name": "string",
      "email": "user@example.com",
      "date": "2019-08-24T14:15:22Z",
      "username": "string"
    },
    "sender": {
      "login": "string",
      "id": 0,
      "node_id": "string",
      "name": "string",
      "email": "string",
      "avatar_url": "http://example.com",
      "gravatar_id": "string",
      "url": "http://example.com",
      "html_url": "http://example.com",
      "followers_url": "http://example.com",
      "following_url": "http://example.com/{endpoint}",
      "gists_url": "http://example.com/{endpoint}",
      "starred_url": "http://example.com/{endpoint}",
      "subscriptions_url": "http://example.com",
      "organizations_url": "http://example.com",
      "repos_url": "http://example.com",
      "events_url": "http://example.com/{endpoint}",
      "received_events_url": "http://example.com",
      "type": "Bot",
      "site_admin": true
    },
    "installation": {
      "id": 0,
      "node_id": "string"
    },
    "organization": {
      "login": "string",
      "id": 0,
      "node_id": "string",
      "url": "http://example.com",
      "html_url": "http://example.com",
      "repos_url": "http://example.com",
      "events_url": "http://example.com",
      "hooks_url": "http://example.com",
      "issues_url": "http://example.com",
      "members_url": "http://example.com/{endpoint}",
      "public_members_url": "http://example.com/{endpoint}",
      "avatar_url": "http://example.com",
      "description": "string"
    }
  }'

Responses

OK.

Bodyapplication/problem+json
messagestring

A human-readable message with more details.

Example: "Job created"
eventstring

Type of incoming webhook event.

Example: "push"
jobIdstring

Created Scout job ID.

Example: "sjob_01h4gev6h1j50ge5z3yn28ge5e"
Response
application/problem+json
{
  "message": "Job created",
  "event": "push",
  "jobId": "sjob_01h4gev6h1j50ge5z3yn28ge5e"
}

Create GitLab webhook event

Request

Register and start to process GitLab repository event. For now only push and create merge request events are supported.

Security
GitlabApiKey
Bodyapplication/jsonrequired
One of:
object push-2 Recursive 
curl -i -X POST \
  https://redocly.com/_mock/docs/realm/scout/agent-api/openapi/webhooks/gitlab \
  -H 'Content-Type: application/json' \
  -H 'x-gitlab-token: YOUR_API_KEY_HERE' \
  -d '{
    "object_kind": "push",
    "before": "95790bf891e76fee5e1747ab589903a6a1f80f22",
    "after": "da1560886d4f094c3e6c9ef40349f7d38b5d27d7",
    "ref": "refs/heads/main",
    "checkout_sha": "da1560886d4f094c3e6c9ef40349f7d38b5d27d7",
    "user_id": 1,
    "user_name": "John",
    "user_username": "john87",
    "user_email": "john87@email.com",
    "user_avatar": "https://s.gravatar.com/avatar/d4c74594d841139328695756648b6bd6?s=8://s.gravatar.com/avatar/d4c74594d841139328695756648b6bd6?s=80",
    "project_id": 15,
    "project": {
      "id": 0,
      "name": "string",
      "description": "string",
      "web_url": "http://example.com/gitlabhq/gitlab-test",
      "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=40&d=identicon",
      "git_ssh_url": "ssh://git@example.com/gitlabhq/gitlab-test.git",
      "git_http_url": "http://example.com/gitlabhq/gitlab-test.git",
      "namespace": "GitlabHQ",
      "visibility_level": 20,
      "path_with_namespace": "gitlabhq/gitlab-test",
      "default_branch": "develop",
      "homepage": "http://example.com/gitlabhq/gitlab-test",
      "url": "http://example.com/gitlabhq/gitlab-test.git",
      "ssh_url": "ssh://git@example.com/gitlabhq/gitlab-test.git",
      "http_url": "http://example.com/gitlabhq/gitlab-test.git"
    },
    "repository": {
      "name": "Awesome project",
      "url": "http://example.com/gitlabhq/awesome-project.git",
      "description": "Awesome project description.",
      "homepage": "http://example.com/gitlabhq/awesome-project",
      "git_http_url": "http://example.com/gitlabhq/gitlab-test.git",
      "git_ssh_url": "ssh://git@example.com/gitlabhq/gitlab-test.git",
      "web_url": "http://example.com/gitlabhq/awesome-project",
      "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=40&d=identicon",
      "visibility_level": 20
    },
    "commits": [
      {
        "id": "b6568db1bc1dcd7f8b4d5a946b0b91f9dacd7327",
        "message": "fixed readme",
        "timestamp": "2019-08-24T14:15:22Z",
        "url": "http://example.com/mike/diaspora/commit/da1560886d4f094c3e6c9ef40349f7d38b5d27d7",
        "author": {
          "name": "John",
          "email": "john.doe@email.com"
        },
        "added": [
          "CHANGELOG"
        ],
        "modified": [
          "app/controller/application.rb"
        ],
        "removed": [
          "app/controller/product.rb"
        ]
      }
    ],
    "total_commits_count": 34
  }'

Responses

OK.

Bodyapplication/problem+json
messagestring

A human-readable message with more details.

Example: "Job created"
eventstring

Type of incoming webhook event.

Example: "push"
jobIdstring

Created Scout job ID.

Example: "sjob_01h4gev6h1j50ge5z3yn28ge5e"
Response
application/problem+json
{
  "message": "Job created",
  "event": "push",
  "jobId": "sjob_01h4gev6h1j50ge5z3yn28ge5e"
}