NAV Navigation
Shell HTTP JavaScript Node.js Ruby Python Java Go

Remote Provider Service v2.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

API for the Remote Provider Service. Exposes health checks and supports communication with Git Providers.

Base URLs:

Terms of service Email: Blue Team Web: Blue Team License: Codacy. All rights reserved

organization

listOrganizationMembers

Code samples

# You can also use wget
curl -X GET http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationIdentifier}/members \
  -H 'Accept: application/json' \
  -H 'token: string'


GET http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationIdentifier}/members HTTP/1.1
Host: rps.dev.codacy.org
Accept: application/json
token: string


var headers = {
  'Accept':'application/json',
  'token':'string'

};

$.ajax({
  url: 'http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationIdentifier}/members',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'token':'string'

};

fetch('http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationIdentifier}/members',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'token' => 'string'
}

result = RestClient.get 'http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationIdentifier}/members',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'token': 'string'
}

r = requests.get('http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationIdentifier}/members', params={

}, headers = headers)

print r.json()


URL obj = new URL("http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationIdentifier}/members");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "token": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationIdentifier}/members", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationIdentifier}/members

Finds all members for remote organization name of a specific provider

Finds all members for remote organization name of a specific provider.

Parameters

Name In Type Required Description
provider path string true Git Provider
remoteOrganizationIdentifier path string true Remote organization identifier
remoteUserIdentifier path string true Remote user identifier
cursor query string false Cursor to list elements after.
limit query string(int32) false Number of items to return.
token header string false Provider Token

Enumerated Values

Parameter Value
provider gh
provider ghe
provider gl
provider gle

Example responses

Successful operation

{
  "pagination": {
    "cursor": "YugfO05==",
    "limit": 20,
    "total": 73
  },
  "data": [
    {
      "id": 1,
      "name": "Machado",
      "avatar": "https://www.gravatar.com/avatar/some-random-avatar"
    }
  ]
}

400 Response

{
  "description": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation RemoteUserListResponse
400 Bad Request Missing authentication token or unknown provider Error
500 Internal Server Error Unexpected error happened Error

listOrganizationRepositories

Code samples

# You can also use wget
curl -X GET http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories \
  -H 'Accept: application/json' \
  -H 'token: string'


GET http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories HTTP/1.1
Host: rps.dev.codacy.org
Accept: application/json
token: string


var headers = {
  'Accept':'application/json',
  'token':'string'

};

$.ajax({
  url: 'http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'token':'string'

};

fetch('http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'token' => 'string'
}

result = RestClient.get 'http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'token': 'string'
}

r = requests.get('http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories', params={

}, headers = headers)

print r.json()


URL obj = new URL("http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "token": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories

Finds all repos for remote organization name of a specific provider

Finds all repos for remote organization name of a specific provider.

Parameters

Name In Type Required Description
provider path string true Git Provider
remoteOrganizationName path string true Remote organization name
remoteUserIdentifier path string true Remote user identifier
search query string false Filter the results searching by this string.
cursor query string false Cursor to list elements after.
limit query string(int32) false Number of items to return.
token header string false Provider Token

Enumerated Values

Parameter Value
provider gh
provider ghe
provider gl
provider gle

Example responses

Successful operation

{
  "pagination": {
    "cursor": "YugfO05==",
    "limit": 20,
    "total": 73
  },
  "data": [
    {
      "id": 1,
      "name": "Website",
      "owner": "Codacy",
      "isPrivate": true,
      "permissions": {
        "admin": true,
        "push": true,
        "pull": true
      }
    }
  ]
}

400 Response

{
  "description": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation RemoteRepositoryListResponse
400 Bad Request Missing authentication token or unknown provider Error
500 Internal Server Error Unexpected error happened Error

listRepositoryMembers

Code samples

# You can also use wget
curl -X GET http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/memberships \
  -H 'Accept: application/json' \
  -H 'token: string'


GET http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/memberships HTTP/1.1
Host: rps.dev.codacy.org
Accept: application/json
token: string


var headers = {
  'Accept':'application/json',
  'token':'string'

};

$.ajax({
  url: 'http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/memberships',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'token':'string'

};

fetch('http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/memberships',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'token' => 'string'
}

result = RestClient.get 'http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/memberships',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'token': 'string'
}

r = requests.get('http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/memberships', params={

}, headers = headers)

print r.json()


URL obj = new URL("http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/memberships");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "token": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/memberships", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/memberships

List people that have access to a repository

List people that have access to a repository.

Parameters

Name In Type Required Description
provider path string true Git Provider
remoteOrganizationName path string true Remote organization name
remoteUserIdentifier path string true Remote user identifier
repositoryName path string true Repository name to retrieve
cursor query string false Cursor to list elements after.
limit query string(int32) false Number of items to return.
token header string false Provider Token

Enumerated Values

Parameter Value
provider gh
provider ghe
provider gl
provider gle

Example responses

Successful operation

{
  "pagination": {
    "cursor": "YugfO05==",
    "limit": 20,
    "total": 73
  },
  "data": [
    {
      "id": 1
    },
    {
      "id": 2
    }
  ]
}

400 Response

{
  "description": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation RemoteRepositoryMembershipListResponse
400 Bad Request Missing authentication token or unknown provider Error
500 Internal Server Error Unexpected error happened Error

listOrganizationsMemberships

Code samples

# You can also use wget
curl -X GET http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/memberships \
  -H 'Accept: application/json' \
  -H 'token: string'


GET http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/memberships HTTP/1.1
Host: rps.dev.codacy.org
Accept: application/json
token: string


var headers = {
  'Accept':'application/json',
  'token':'string'

};

$.ajax({
  url: 'http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/memberships',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'token':'string'

};

fetch('http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/memberships',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'token' => 'string'
}

result = RestClient.get 'http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/memberships',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'token': 'string'
}

r = requests.get('http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/memberships', params={

}, headers = headers)

print r.json()


URL obj = new URL("http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/memberships");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "token": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/memberships", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /{provider}/users/{remoteUserIdentifier}/organizations/memberships

Finds all membership status for the user's organizations

Finds all membership status for the user's organizations.

Parameters

Name In Type Required Description
provider path string true Git Provider
remoteUserIdentifier path string true Remote user identifier
cursor query string false Cursor to list elements after.
limit query string(int32) false Number of items to return.
token header string false Provider Token

Enumerated Values

Parameter Value
provider gh
provider ghe
provider gl
provider gle

Example responses

Successful operation

{
  "pagination": {
    "cursor": "YugfO05==",
    "limit": 20,
    "total": 73
  },
  "data": [
    {
      "userId": 1,
      "organizationId": 1,
      "status": "active",
      "role": "admin"
    }
  ]
}

400 Response

{
  "description": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation RemoteOrganizationMembershipListResponse
400 Bad Request Missing authentication token or unknown provider Error
500 Internal Server Error Unexpected error happened Error

getRepository

Code samples

# You can also use wget
curl -X GET http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName} \
  -H 'Accept: application/json' \
  -H 'token: string'


GET http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName} HTTP/1.1
Host: rps.dev.codacy.org
Accept: application/json
token: string


var headers = {
  'Accept':'application/json',
  'token':'string'

};

$.ajax({
  url: 'http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'token':'string'

};

fetch('http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'token' => 'string'
}

result = RestClient.get 'http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'token': 'string'
}

r = requests.get('http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}', params={

}, headers = headers)

print r.json()


URL obj = new URL("http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "token": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}

Finds a specific repo for remote organization name and repository name of a specific provider

Finds a specific repo for remote organization name and repository name of a specific provider.

Parameters

Name In Type Required Description
provider path string true Git Provider
remoteOrganizationName path string true Remote organization name
remoteUserIdentifier path string true Remote user identifier
repositoryName path string true Repository name to retrieve
token header string false Provider Token

Enumerated Values

Parameter Value
provider gh
provider ghe
provider gl
provider gle

Example responses

Successful operation

{
  "data": {
    "id": 1,
    "name": "Website",
    "owner": "Codacy",
    "isPrivate": true,
    "permissions": {
      "admin": true,
      "push": true,
      "pull": true
    }
  }
}

400 Response

{
  "description": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation RemoteRepositoryResponse
400 Bad Request Missing authentication token or unknown provider Error
500 Internal Server Error Unexpected error happened Error

createCheck

Code samples

# You can also use wget
curl -X POST http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/checks \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'token: string'


POST http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/checks HTTP/1.1
Host: rps.dev.codacy.org
Content-Type: application/json
Accept: application/json
token: string


var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'token':'string'

};

$.ajax({
  url: 'http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/checks',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "name": "string",
  "headSha": "string",
  "status": "in_progress",
  "conclusion": "success",
  "output": {
    "title": "string",
    "summary": "string",
    "annotations": [
      {
        "path": "string",
        "annotationLevel": "notice",
        "title": "string",
        "message": "string",
        "startLine": 0,
        "endLine": 0
      }
    ]
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'token':'string'

};

fetch('http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/checks',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'token' => 'string'
}

result = RestClient.post 'http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/checks',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'token': 'string'
}

r = requests.post('http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/checks', params={

}, headers = headers)

print r.json()


URL obj = new URL("http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/checks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "token": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/checks", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/checks

Creates a check on a specific commit

Body parameter

{
  "name": "string",
  "headSha": "string",
  "status": "in_progress",
  "conclusion": "success",
  "output": {
    "title": "string",
    "summary": "string",
    "annotations": [
      {
        "path": "string",
        "annotationLevel": "notice",
        "title": "string",
        "message": "string",
        "startLine": 0,
        "endLine": 0
      }
    ]
  }
}

Parameters

Name In Type Required Description
provider path string true Git Provider
remoteUserIdentifier path string true Remote user identifier
remoteOrganizationName path string true Remote organization name
repositoryName path string true Repository name to retrieve
token header string false Provider Token
body body Check true none

Enumerated Values

Parameter Value
provider gh
provider ghe
provider gl
provider gle

Example responses

200 Response

{
  "id": 0
}

Responses

Status Meaning Description Schema
200 OK Successful operation CheckCreatedResponse
400 Bad Request Missing authentication token or unknown provider Error
500 Internal Server Error Unexpected error happened Error

updateCheck

Code samples

# You can also use wget
curl -X POST http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/checks/{checkIdentifier} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'token: string'


POST http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/checks/{checkIdentifier} HTTP/1.1
Host: rps.dev.codacy.org
Content-Type: application/json
Accept: application/json
token: string


var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'token':'string'

};

$.ajax({
  url: 'http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/checks/{checkIdentifier}',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "conclusion": "success",
  "output": {
    "title": "string",
    "summary": "string",
    "annotations": [
      {
        "path": "string",
        "annotationLevel": "notice",
        "title": "string",
        "message": "string",
        "startLine": 0,
        "endLine": 0
      }
    ]
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'token':'string'

};

fetch('http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/checks/{checkIdentifier}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'token' => 'string'
}

result = RestClient.post 'http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/checks/{checkIdentifier}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'token': 'string'
}

r = requests.post('http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/checks/{checkIdentifier}', params={

}, headers = headers)

print r.json()


URL obj = new URL("http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/checks/{checkIdentifier}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "token": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/checks/{checkIdentifier}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/repositories/{repositoryName}/checks/{checkIdentifier}

Update a check with a specific id

Body parameter

{
  "conclusion": "success",
  "output": {
    "title": "string",
    "summary": "string",
    "annotations": [
      {
        "path": "string",
        "annotationLevel": "notice",
        "title": "string",
        "message": "string",
        "startLine": 0,
        "endLine": 0
      }
    ]
  }
}

Parameters

Name In Type Required Description
provider path string true Git Provider
remoteUserIdentifier path string true Remote user identifier
remoteOrganizationName path string true Remote organization name
repositoryName path string true Repository name to retrieve
checkIdentifier path string true Check identifier
token header string false Provider Token
body body OutputBody true none

Enumerated Values

Parameter Value
provider gh
provider ghe
provider gl
provider gle

Example responses

200 Response

{
  "id": 0
}

Responses

Status Meaning Description Schema
200 OK Successful operation CheckCreatedResponse
400 Bad Request Missing authentication token or unknown provider Error
500 Internal Server Error Unexpected error happened Error

getOrganization

Code samples

# You can also use wget
curl -X GET http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationIdentifier} \
  -H 'Accept: application/json' \
  -H 'token: string'


GET http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationIdentifier} HTTP/1.1
Host: rps.dev.codacy.org
Accept: application/json
token: string


var headers = {
  'Accept':'application/json',
  'token':'string'

};

$.ajax({
  url: 'http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationIdentifier}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'token':'string'

};

fetch('http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationIdentifier}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'token' => 'string'
}

result = RestClient.get 'http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationIdentifier}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'token': 'string'
}

r = requests.get('http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationIdentifier}', params={

}, headers = headers)

print r.json()


URL obj = new URL("http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationIdentifier}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "token": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationIdentifier}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationIdentifier}

Finds information for a specific organization and membership for the user

Finds membership status for the user in a specific organization.

Parameters

Name In Type Required Description
provider path string true Git Provider
remoteOrganizationIdentifier path string true Remote organization identifier
remoteUserIdentifier path string true Remote user identifier
token header string false Provider Token

Enumerated Values

Parameter Value
provider gh
provider ghe
provider gl
provider gle

Example responses

Successful operation

{
  "data": {
    "id": 1,
    "name": "Codacy",
    "avatar": "https://www.gravatar.com/avatar/some-random-avatar",
    "userId": "1",
    "userRole": "Admin"
  }
}

400 Response

{
  "description": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation RemoteOrganizationResponse
400 Bad Request Missing authentication token or unknown provider Error
500 Internal Server Error Unexpected error happened Error

cleanCache

Code samples

# You can also use wget
curl -X POST http://rps.dev.codacy.org/v2/cleanCache \
  -H 'Accept: application/json' \
  -H 'token: string'


POST http://rps.dev.codacy.org/v2/cleanCache HTTP/1.1
Host: rps.dev.codacy.org
Accept: application/json
token: string


var headers = {
  'Accept':'application/json',
  'token':'string'

};

$.ajax({
  url: 'http://rps.dev.codacy.org/v2/cleanCache',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'token':'string'

};

fetch('http://rps.dev.codacy.org/v2/cleanCache',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'token' => 'string'
}

result = RestClient.post 'http://rps.dev.codacy.org/v2/cleanCache',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'token': 'string'
}

r = requests.post('http://rps.dev.codacy.org/v2/cleanCache', params={

}, headers = headers)

print r.json()


URL obj = new URL("http://rps.dev.codacy.org/v2/cleanCache");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "token": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://rps.dev.codacy.org/v2/cleanCache", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cleanCache

Cleans all cache entries for a user token

Cleans all cache entries for a user token.

Parameters

Name In Type Required Description
token header string true Provider Token

Example responses

400 Response

{
  "description": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful operation None
400 Bad Request Missing authentication token or unknown provider Error
500 Internal Server Error Unexpected error happened Error

createOrganizationHook

Code samples

# You can also use wget
curl -X POST http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/hooks \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'token: string'


POST http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/hooks HTTP/1.1
Host: rps.dev.codacy.org
Content-Type: application/json
Accept: application/json
token: string


var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'token':'string'

};

$.ajax({
  url: 'http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/hooks',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "callback": "string",
  "secret": "string",
  "events": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'token':'string'

};

fetch('http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/hooks',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'token' => 'string'
}

result = RestClient.post 'http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/hooks',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'token': 'string'
}

r = requests.post('http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/hooks', params={

}, headers = headers)

print r.json()


URL obj = new URL("http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/hooks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "token": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/hooks", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /{provider}/users/{remoteUserIdentifier}/organizations/{remoteOrganizationName}/hooks

Creates a hook against the given organization

Body parameter

{
  "callback": "string",
  "secret": "string",
  "events": [
    "string"
  ]
}

Parameters

Name In Type Required Description
provider path string true Git Provider
remoteOrganizationName path string true Remote organization name
remoteUserIdentifier path string true Remote user identifier
token header string false Provider Token
body body OrganizationHook true none

Enumerated Values

Parameter Value
provider gh
provider ghe
provider gl
provider gle

Example responses

400 Response

{
  "description": "string"
}

Responses

Status Meaning Description Schema
201 Created Created None
400 Bad Request Missing authentication token or unknown provider Error
500 Internal Server Error Unexpected error happened Error

createSystemHook

Code samples

# You can also use wget
curl -X POST http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/hooks/system \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'token: string'


POST http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/hooks/system HTTP/1.1
Host: rps.dev.codacy.org
Content-Type: application/json
Accept: application/json
token: string


var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'token':'string'

};

$.ajax({
  url: 'http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/hooks/system',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "callback": "string",
  "secret": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'token':'string'

};

fetch('http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/hooks/system',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'token' => 'string'
}

result = RestClient.post 'http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/hooks/system',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'token': 'string'
}

r = requests.post('http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/hooks/system', params={

}, headers = headers)

print r.json()


URL obj = new URL("http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/hooks/system");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "token": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://rps.dev.codacy.org/v2/{provider}/users/{remoteUserIdentifier}/hooks/system", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /{provider}/users/{remoteUserIdentifier}/hooks/system

Creates a hook in the platform

Body parameter

{
  "callback": "string",
  "secret": "string"
}

Parameters

Name In Type Required Description
provider path string true Git Provider
remoteUserIdentifier path string true Remote user identifier
token header string false Provider Token
body body SystemHook true none

Enumerated Values

Parameter Value
provider gh
provider ghe
provider gl
provider gle

Example responses

400 Response

{
  "description": "string"
}

Responses

Status Meaning Description Schema
201 Created Created None
400 Bad Request Missing authentication token or unknown provider Error
500 Internal Server Error Unexpected error happened Error

Schemas

RemoteOrganizationIdentifier

"string"

Properties

Name Type Required Restrictions Description
anonymous string false none none

RemoteUserIdentifier

"string"

Properties

Name Type Required Restrictions Description
anonymous string false none none

RemoteRepositoryIdentifier

"string"

Properties

Name Type Required Restrictions Description
anonymous string false none none

PaginationInfo

{
  "cursor": "string",
  "limit": 0,
  "total": 0
}

Properties

Name Type Required Restrictions Description
cursor string false none none
limit integer(int32) false none none
total integer(int32) false none none

RemoteOrganization

{
  "id": "string",
  "name": "string",
  "avatar": "string",
  "userId": "string",
  "userRole": "string"
}

Properties

Name Type Required Restrictions Description
id RemoteOrganizationIdentifier true none none
name string true none none
avatar string true none none
userId string true none none
userRole string true none none

RemoteOrganizationResponse

{
  "data": {
    "id": "string",
    "name": "string",
    "avatar": "string",
    "userId": "string",
    "userRole": "string"
  }
}

Properties

Name Type Required Restrictions Description
data RemoteOrganization true none none

RemoteUser

{
  "id": "string",
  "name": "string",
  "avatar": "string"
}

Properties

Name Type Required Restrictions Description
id RemoteUserIdentifier true none none
name string true none none
avatar string true none none

RemoteUserListResponse

{
  "pagination": {
    "cursor": "string",
    "limit": 0,
    "total": 0
  },
  "data": [
    {
      "id": "string",
      "name": "string",
      "avatar": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
pagination PaginationInfo false none none
data [RemoteUser] true none none

RepositoryPermission

{
  "admin": true,
  "push": true,
  "pull": true
}

Properties

Name Type Required Restrictions Description
admin boolean true none none
push boolean true none none
pull boolean true none none

RemoteRepository

{
  "id": "string",
  "name": "string",
  "owner": "string",
  "isPrivate": true,
  "url": "string",
  "permission": {
    "admin": true,
    "push": true,
    "pull": true
  },
  "updatedAt": "2020-02-13T09:11:16Z"
}

Properties

Name Type Required Restrictions Description
id RemoteRepositoryIdentifier true none none
name string true none none
owner string true none none
isPrivate boolean true none none
url string true none none
permission RepositoryPermission true none none
updatedAt string(date-time) true none none

RemoteRepositoryListItem

{
  "id": "string",
  "name": "string",
  "owner": "string",
  "isPrivate": true,
  "url": "string",
  "permission": {
    "admin": true,
    "push": true,
    "pull": true
  },
  "updatedAt": "2020-02-13T09:11:16Z"
}

Properties

Name Type Required Restrictions Description
id RemoteRepositoryIdentifier true none none
name string true none none
owner string true none none
isPrivate boolean true none none
url string true none none
permission RepositoryPermission false none none
updatedAt string(date-time) true none none

RemoteRepositoryResponse

{
  "data": {
    "id": "string",
    "name": "string",
    "owner": "string",
    "isPrivate": true,
    "url": "string",
    "permission": {
      "admin": true,
      "push": true,
      "pull": true
    },
    "updatedAt": "2020-02-13T09:11:16Z"
  }
}

Properties

Name Type Required Restrictions Description
data RemoteRepository true none none

RemoteRepositoryListResponse

{
  "pagination": {
    "cursor": "string",
    "limit": 0,
    "total": 0
  },
  "data": [
    {
      "id": "string",
      "name": "string",
      "owner": "string",
      "isPrivate": true,
      "url": "string",
      "permission": {
        "admin": true,
        "push": true,
        "pull": true
      },
      "updatedAt": "2020-02-13T09:11:16Z"
    }
  ]
}

Properties

Name Type Required Restrictions Description
pagination PaginationInfo false none none
data [RemoteRepositoryListItem] true none none

RemoteOrganizationMembership

{
  "userId": "string",
  "organizationId": "string",
  "role": "string"
}

Properties

Name Type Required Restrictions Description
userId RemoteUserIdentifier true none none
organizationId RemoteOrganizationIdentifier true none none
role string true none none

RemoteOrganizationMembershipListResponse

{
  "pagination": {
    "cursor": "string",
    "limit": 0,
    "total": 0
  },
  "data": [
    {
      "userId": "string",
      "organizationId": "string",
      "role": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
pagination PaginationInfo false none none
data [RemoteOrganizationMembership] true none none

RemoteRepositoryMembership

{
  "userId": "string"
}

Properties

Name Type Required Restrictions Description
userId RemoteUserIdentifier true none none

RemoteRepositoryMembershipListResponse

{
  "pagination": {
    "cursor": "string",
    "limit": 0,
    "total": 0
  },
  "data": [
    {
      "userId": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
pagination PaginationInfo false none none
data [RemoteRepositoryMembership] true none none

OrganizationHook

{
  "callback": "string",
  "secret": "string",
  "events": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
callback string true none The url that GitHub will call when an event is fired
secret string true none Setting a webhook secret allows you to ensure that POST requests sent to the payload URL are from GitHub.
events [string] false none An array of GitHub events which will trigger when changes happen. Will default to 'organization', 'meta', 'repository' if empty

SystemHook

{
  "callback": "string",
  "secret": "string"
}

Properties

Name Type Required Restrictions Description
callback string true none The url that the provider will call when an event is fired
secret string true none Setting a webhook secret allows you to ensure that POST requests sent to the payload URL are from the provider.

Annotation

{
  "path": "string",
  "annotationLevel": "notice",
  "title": "string",
  "message": "string",
  "startLine": 0,
  "endLine": 0
}

Properties

Name Type Required Restrictions Description
path string true none The name of the target file
annotationLevel string true none The level of the issue
title string true none Title of the comment
message string true none Message of the comment
startLine integer(int64) true none Line where the comment starts
endLine integer(int64) true none Line where the comment ends

Enumerated Values

Property Value
annotationLevel notice
annotationLevel warning
annotationLevel failure

Output

{
  "title": "string",
  "summary": "string",
  "annotations": [
    {
      "path": "string",
      "annotationLevel": "notice",
      "title": "string",
      "message": "string",
      "startLine": 0,
      "endLine": 0
    }
  ]
}

Properties

Name Type Required Restrictions Description
title string true none none
summary string true none none
annotations [Annotation] false none none

Check

{
  "name": "string",
  "headSha": "string",
  "status": "in_progress",
  "conclusion": "success",
  "output": {
    "title": "string",
    "summary": "string",
    "annotations": [
      {
        "path": "string",
        "annotationLevel": "notice",
        "title": "string",
        "message": "string",
        "startLine": 0,
        "endLine": 0
      }
    ]
  }
}

Properties

Name Type Required Restrictions Description
name string true none Name of the check
headSha string true none Commit sha where the check will be created
status string true none Status of the check
conclusion string false none Conclusion of the check
output Output true none none

Enumerated Values

Property Value
status in_progress
status completed
conclusion success
conclusion failure

OutputBody

{
  "conclusion": "success",
  "output": {
    "title": "string",
    "summary": "string",
    "annotations": [
      {
        "path": "string",
        "annotationLevel": "notice",
        "title": "string",
        "message": "string",
        "startLine": 0,
        "endLine": 0
      }
    ]
  }
}

Properties

Name Type Required Restrictions Description
conclusion string true none Conclusion of the check
output Output true none none

Enumerated Values

Property Value
conclusion success
conclusion failure

CheckCreatedResponse

{
  "id": 0
}

Properties

Name Type Required Restrictions Description
id integer(int64) true none Created check's id

Error

{
  "description": "string"
}

Properties

Name Type Required Restrictions Description
description string true none none
Shell HTTP JavaScript Node.js Ruby Python Java Go