Skip to main content

API Server (1.0.0)

Download OpenAPI specification:Download

RAW API Server.

repository

Available repositories.

Returns list of available repositories accessible by the user.

query Parameters
url
string

Search by Repository URL.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Repository branches.

Returns branches of a repository.

path Parameters
repo_id
required
string

Repository identifier.

Responses

Response samples

Content type
application/json
{
  • "repoId": "string",
  • "url": "string",
  • "branches": [
    ]
}

Repository security.

Returns security rules of a repository.

path Parameters
repo_id
required
string

Repository identifier.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

New repository security setting.

Create new security setting, aka user/role definition on this repository.

path Parameters
repo_id
required
string

Repository identifier.

Request Body schema: application/json

security setting definition

userId
required
string
userName
required
string
repoManager
required
boolean
credentialsManager
required
boolean
developer
required
boolean

Responses

Request samples

Content type
application/json
{
  • "userId": "string",
  • "userName": "string",
  • "repoManager": true,
  • "credentialsManager": true,
  • "developer": true
}

Response samples

Content type
application/json
{
  • "userId": "string",
  • "userName": "string",
  • "repoManager": true,
  • "credentialsManager": true,
  • "developer": true
}

Repository security setting of the given repository for the given user.

Get the security setting of the given repository for the given user.

path Parameters
repo_id
required
string

Repository identifier.

user_id
required
string

User identified.

Responses

Response samples

Content type
application/json
{
  • "userId": "string",
  • "userName": "string",
  • "repoManager": true,
  • "credentialsManager": true,
  • "developer": true
}

Repository security setting of the given repository for the given user.

Update the security setting of the given repository for the given user.

path Parameters
repo_id
required
string

Repository identifier.

user_id
required
string

User identified.

Request Body schema: application/json
userId
required
string
userName
required
string
repoManager
required
boolean
credentialsManager
required
boolean
developer
required
boolean

Responses

Request samples

Content type
application/json
{
  • "userId": "string",
  • "userName": "string",
  • "repoManager": true,
  • "credentialsManager": true,
  • "developer": true
}

Response samples

Content type
application/json
{
  • "userId": "string",
  • "userName": "string",
  • "repoManager": true,
  • "credentialsManager": true,
  • "developer": true
}

Repository security setting of the given repository for the given user.

Delete the security setting of the given repository for the given user.

path Parameters
repo_id
required
string

Repository identifier.

user_id
required
string

User identified.

Responses

Zoho credential initiation request.

Makes request to get verification url for zoho.

path Parameters
repo_id
required
string

Repository identifier.

Request Body schema: application/json

credentials definition

credId
string
name
required
string
region
required
string
object

Responses

Request samples

Content type
application/json
Example
{
  • "credId": "string",
  • "name": "string",
  • "region": "string",
  • "access": {
    },
  • "repositoryType": "S3"
}

Response samples

Content type
application/json
{ }

Repository credentials.

Get all credentials of the given repository.

path Parameters
repo_id
required
string

Repository identifier.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

New repository credentials.

Create new repository credentials

path Parameters
repo_id
required
string

Repository identifier.

Request Body schema: application/json

credentials definition

credId
string
name
required
string
region
required
string
object

Responses

Request samples

Content type
application/json
Example
{
  • "credId": "string",
  • "name": "string",
  • "region": "string",
  • "access": {
    },
  • "repositoryType": "S3"
}

Response samples

Content type
application/json
Example
{
  • "credId": "string",
  • "name": "string",
  • "region": "string",
  • "access": {
    },
  • "repositoryType": "S3"
}

Repository credentials with the given name.

Get repository credentials with the given name.

path Parameters
repo_id
required
string

Repository identifier.

cred_id
required
string

Credentials identifier.

Responses

Response samples

Content type
application/json
Example
{
  • "credId": "string",
  • "name": "string",
  • "region": "string",
  • "access": {
    },
  • "repositoryType": "S3"
}

Repository credentials with the given name.

Update repository credentials with the given name.

path Parameters
repo_id
required
string <base64>

Repository identifier.

cred_id
required
string

Credentials identifier.

Request Body schema: application/json

user role definition

credId
string
name
required
string
region
required
string
object

Responses

Request samples

Content type
application/json
Example
{
  • "credId": "string",
  • "name": "string",
  • "region": "string",
  • "access": {
    },
  • "repositoryType": "S3"
}

Response samples

Content type
application/json
Example
{
  • "credId": "string",
  • "name": "string",
  • "region": "string",
  • "access": {
    },
  • "repositoryType": "S3"
}

Repository credentials with the given name.

Delete repository credentials with the given name.

path Parameters
repo_id
required
string

Repository identifier.

cred_id
required
string

Credentials identifier.

Responses

Repository credentials access.

Check repository credentials access.

path Parameters
repo_id
required
string

Repository identifier.

cred_id
required
string

Credentials identifier.

Responses

Response samples

Content type
application/json
Example
{
  • "credId": "string",
  • "access": true
}

Repository refresh tasks status.

Returns status regarding repository refresh tasks.

Responses

Response samples

Content type
application/json
{
  • "taskCount": 0,
  • "active": true,
  • "processing": [
    ]
}

endpoint

Available endpoints.

Returns list of available endpoints accessible by the user.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Endpoint description.

Returns description of an endpoint.

path Parameters
endpoint_id
required
string

Endpoint identifier.

header Parameters
Accept
required
string

defines if to show code or not

Responses

Response samples

Content type
application/vnd.endpoint-code+json
Example
{
  • "endpointId": "string",
  • "repositoryUrl": "string",
  • "path": "string",
  • "branch": "string",
  • "title": "string",
  • "description": "string",
  • "tags": [
    ],
  • "termsOfService": "string",
  • "author": "string",
  • "contact": {
    },
  • "license": {
    },
  • "version": "string",
  • "code": "string",
  • "language": "string",
  • "outputType": "string",
  • "outputFormat": "csv",
  • "parameters": [
    ],
  • "type": "GET"
}

Endpoint security.

Returns security rules of an endpoint.

path Parameters
endpoint_id
required
string

Endpoint identifier.

Responses

Response samples

Content type
application/json
{
  • "visibility": true,
  • "scopes": [
    ]
}

Endpoint security.

Update security rules of an endpoint.

path Parameters
endpoint_id
required
string

Endpoint identifier.

query Parameters
isPrivate
boolean

Responses

Response samples

Content type
application/json
{
  • "visibility": true,
  • "scopes": [
    ]
}

Endpoint deployment settings.

Returns deployment settings of an endpoint.

path Parameters
endpoint_id
required
string

Endpoint identifier.

Responses

Response samples

Content type
application/json
{
  • "computeClass": "string",
  • "computeCacheSizeMb": 0,
  • "computeLimitSeconds": 0,
  • "expireSeconds": 0,
  • "format": "string"
}

Endpoint credits.

Returns credits of an endpoint.

path Parameters
endpoint_id
required
string

Endpoint identifier.

Responses

Response samples

Content type
application/json
{
  • "credits-1h": 0,
  • "credits-24h": 0,
  • "creditsBillingPeriod": 0
}

OpenAPI description.

Returns OpenAPI description of an endpoint or an organization.

path Parameters
endpoint_id
required
string

Endpoint identifier.

query Parameters
version
string
Default: "3.0.0"

OpenAPI version.

Responses

execution

Execute test code.

Execute test code and returns results/errors.

Request Body schema: application/json

Program definition

required
RepositoryReferenceById (object) or RepositoryReferenceByUrl (object) (RepositoryReference)
language
required
string
code
required
string
declaration
string
object
computeClass
required
string
computeLimitSeconds
integer <int32> >= 1
outputFormat
required
string (MediaTypes)
Enum: "csv" "json" "hjson" "xml"

Responses

Request samples

Content type
application/json
{
  • "repositoryReference": {
    },
  • "language": "string",
  • "code": "string",
  • "declaration": "string",
  • "arguments": {
    },
  • "computeClass": "string",
  • "computeLimitSeconds": 1,
  • "outputFormat": "csv"
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Retrieves program output.

Retrieves program output.

path Parameters
programId
required
string

Program ID.

Responses

Response samples

Content type
{ }

Retrieves program logs.

Retrieves program logs.

path Parameters
programId
required
string

Program ID.

query Parameters
level
string (LogLevel)
Enum: "trace" "debug" "info" "warn" "error"

Log level to filter.

start
integer <int32>
Default: 0

Index of first log to retrieve. Default: 0.

limit
integer <int32>
Default: 100

How many log entries to return. Default: 100.

Responses

Response samples

Content type
application/json
{
  • "start": 0,
  • "size": 0,
  • "logs": [
    ]
}

Deletes program.

Deletes program.

path Parameters
programId
required
string

Program ID.

Responses

Validate test code.

Validate test code and returns the validation result.

Request Body schema: application/json

Program definition

required
RepositoryReferenceById (object) or RepositoryReferenceByUrl (object) (RepositoryReference)
language
required
string
code
required
string

Responses

Request samples

Content type
application/json
{
  • "repositoryReference": {
    },
  • "language": "string",
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "declarations": {
    },
  • "tipe": "string",
  • "comment": "string"
}

public endpoint

Available endpoints.

Returns list of available of endpoints accessible by the user with publicly visible information.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

OpenAPI description.

Returns OpenAPI description of an endpoint or an organization.

path Parameters
endpoint_id
required
string

Endpoint identifier.

query Parameters
version
string
Default: "3.0.0"

OpenAPI version.

Responses

Get client code.

Returns client code used for calling the selected endpoint.

path Parameters
endpoint_id
required
string

Endpoint identifier.

query Parameters
language
string
Default: "curl"
Enum: "curl" "java" "scala" "python"

Language code, e.g. Java, Scala, Python, etc..

Responses

Response samples

Content type
application/json
{
  • "language": "curl",
  • "code": "string"
}

Get Excel file for invocation.

Returns Excel file used for calling the selected endpoint.

path Parameters
endpoint_id
required
string

Endpoint identifier.

Responses

Endpoint description.

Returns description of an endpoint.

path Parameters
endpoint_id
required
string

Endpoint identifier.

header Parameters
Accept
required
string

defines if to show code or not

Responses

Response samples

Content type
application/vnd.endpoint-code+json
Example
{
  • "endpointId": "string",
  • "repositoryUrl": "string",
  • "path": "string",
  • "branch": "string",
  • "title": "string",
  • "description": "string",
  • "tags": [
    ],
  • "termsOfService": "string",
  • "author": "string",
  • "contact": {
    },
  • "license": {
    },
  • "version": "string",
  • "code": "string",
  • "language": "string",
  • "outputType": "string",
  • "outputFormat": "csv",
  • "parameters": [
    ],
  • "type": "GET"
}

repository events

Repository events.

Returns events that occured during a repository import or refresh process.

path Parameters
repo_id
required
string

Repository identifier.

query Parameters
start
integer

The number of events to skip before starting to collect the results.

limit
integer

The numbers of events to return in total.

Responses

Response samples

Content type
application/json
null

Repository event detailed messages.

Returns detailed messages regarding an event during a repository import or refresh process.

path Parameters
repo_event_id
required
string

Repository event identifier.

query Parameters
start
integer

The number of details to skip before starting to collect the results.

limit
integer

The numbers of details to return in total.

Responses

Response samples

Content type
application/json
null

Repository branch events.

Returns branch events for the inquired repository event id.

path Parameters
repo_event_id
required
string

Repository event identifier.

query Parameters
start
integer

The number of events to skip before starting to collect the results.

limit
integer

The numbers of events to return in total.

Responses

Response samples

Content type
application/json
null

Repository branch event messages.

Returns branch messages for the inquired branch event id.

path Parameters
branch_event_id
required
string

Branch event identifier.

query Parameters
start
integer

The number of messages to skip before starting to collect the results.

limit
integer

The numbers of messages to return in total.

Responses

Response samples

Content type
application/json
null

Repository branch file events.

Returns branch file events for the inquired branch event id.

path Parameters
branch_event_id
required
string

Branch event identifier.

query Parameters
start
integer

The number of messages to skip before starting to collect the results.

limit
integer

The numbers of messages to return in total.

Responses

Response samples

Content type
application/json
null

Repository branch yaml event.

Returns the yaml event represented by the inquired yaml event id.

path Parameters
event_id
required
string

Yaml event identifier.

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ]
}

Repository branch rql event.

Returns the rql event represented by the inquired rql event id.

path Parameters
event_id
required
string

Rql event identifier.

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ]
}

endpoint events

Endpoint events.

Returns events of a given endpoint.

path Parameters
endpoint_id
required
string

Endpoint identifier.

query Parameters
start
integer

The number of events to skip before starting to collect the results.

limit
integer

The numbers of events to return in total.

Responses

Response samples

Content type
application/json
null

Endpoint event messages.

Returns messages of a given endpoint event.

path Parameters
endpoint_event_id
required
string

Endpoint event identifier.

query Parameters
start
integer

The number of events to skip before starting to collect the results.

limit
integer

The numbers of events to return in total.

Responses

Response samples

Content type
application/json
null

installations

Installations of current instance.

Returns the installations of the current instance.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

New installation.

Registers a new installation.

path Parameters
id
required
string

Github Installation Identifier.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

permissions

Permissions of a user.

Returns the permissions a user holds.

path Parameters
user_email
required
string

User identifier.

Responses

Response samples

Content type
application/json
{
  • "producerRoles": "string",
  • "consumerScopes": "string",
  • "account": "string",
  • "active": true
}

Edit permissions of a user.

Edit the permissions a user holds.

path Parameters
user_email
required
string

User identifier.

Request Body schema: application/json

permissions payload

producerRoles
string
consumerScopes
string

Responses

Request samples

Content type
application/json
{
  • "producerRoles": "string",
  • "consumerScopes": "string"
}

Users with permissions.

Returns the users along with the permissions.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

add permissions for users.

an admin sets up users and permissions for his instance.

Request Body schema: application/json

user and permissions payload

Array
producerRoles
required
string
consumerScopes
required
string
account
required
string
active
required
boolean
verifyAuth
required
boolean

Responses

Request samples

Content type
application/json
[
  • {
    }
]

invites users and adds permissions.

an admin sets up users and permissions for this instance. Also sends invitation emails.

Request Body schema: application/json

user and permissions payload

Array
producerRoles
required
string
consumerScopes
required
string
account
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

activate a registered user.

a user has responded to an activation email.

path Parameters
user_email
required
string

User email identifier.

Responses

Deletes a user.

Delete the user along with all the permissions he/she owns.

path Parameters
user_email
required
string

User identifier.

Responses

api-keys

API keys

Returns the list of defined api keys and metadata

Responses

Response samples

Content type
application/json
[
  • {
    }
]

generate a new API key with the required properties

Request Body schema: application/json

API Key properties

expires_at
required
string <date-time>
name
required
string
active
required
boolean
Array of objects (ScopeMeta)

Responses

Request samples

Content type
application/json
{
  • "expires_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "active": true,
  • "scopes": [
    ]
}

activate/deactivate an API key

path Parameters
key_id
required
string

API Key identifier.

activate
required
boolean

activate/deactivate API key

Responses

delete API key

path Parameters
key_id
required
string

API Key identifier.

Responses

scopes

List scopes

Returns the list of defined scopes

Responses

Response samples

Content type
application/json
[
  • {
    }
]

lsp

Does an LSP code validation request.

Sends the code to be validated, and returns a collection of errors

Request Body schema: application/json

Code and needed parameters,

required
object (LspRequestProperties)
RepositoryReferenceById (object) or RepositoryReferenceByUrl (object) (RepositoryReference)
language
required
string
code
required
string
object

Responses

Request samples

Content type
application/json
{
  • "lspRequestProperties": {
    }
}

Response samples

Content type
application/json
{
  • "declarations": {
    },
  • "tipe": "string",
  • "comment": "string"
}

Does an LSP formatting request.

Sends the code to be formatted, and receives the formatted code.

Request Body schema: application/json

Code and needed parameters,

required
object (LspRequestProperties)
numberOfSpaces
required
integer
useTabs
required
boolean

Responses

Request samples

Content type
application/json
{
  • "lspRequestProperties": {
    },
  • "numberOfSpaces": 0,
  • "useTabs": true
}

Response samples

Content type
application/json
{
  • "formattedCode": "string",
  • "errors": [
    ]
}

Does the autocompletion request.

Given the code and the trigger type, it returns the list of possible autocompletion items.

Request Body schema: application/json

Code and the triggering character,

object (LspRequestProperties)
triggeringChar
string
required
object (Position)

Responses

Request samples

Content type
application/json
{
  • "lspRequestProperties": {
    },
  • "triggeringChar": "string",
  • "position": {
    }
}

Response samples

Content type
application/json
{
  • "autocompletionItems": [
    ],
  • "errors": [
    ]
}

Does the hover request.

Given a code position, returns it type.

Request Body schema: application/json

The position of the hover

required
object (LspRequestProperties)
required
object (Position)

Responses

Request samples

Content type
application/json
{
  • "lspRequestProperties": {
    },
  • "position": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "lspTooltip": {
    }
}

Does the go to definition request.

Given a code position, the position of its definition.

Request Body schema: application/json

The position of token to be found variable

required
object (LspRequestProperties)
required
object (Position)

Responses

Request samples

Content type
application/json
{
  • "lspRequestProperties": {
    },
  • "position": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "position": {
    }
}

Does the go to definition request.

The position of the rename token

Request Body schema: application/json

A name - type pair

required
object (LspRequestProperties)
required
object (Position)

Responses

Request samples

Content type
application/json
{
  • "lspRequestProperties": {
    },
  • "position": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "positions": [
    ]
}