Skip to main content
API docs by Redocly

API Server (2.1.0)

Download OpenAPI specification:Download

RAW API Server.

repositories

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 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

name
required
string
bucket
required
string
region
string
object

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "bucket": "string",
  • "region": "string",
  • "credentials": {
    },
  • "credentialType": "S3"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "credentialType": "string",
  • "supportedLanguages": [
    ]
}

Update repository credentials with the given name.

Update repository credentials with the given name.

path Parameters
repo_id
required
string

Repository identifier.

Request Body schema: application/json

credential patch definition

name
required
string
bucket
string
region
string or null
object or null

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "bucket": "string",
  • "region": "string",
  • "credentials": {
    },
  • "credentialType": "S3"
}

Response samples

Content type
application/json
Example
{}

Repository credentials with the given credential name.

Get repository credentials with the given credential name.

path Parameters
repo_id
required
string

Repository identifier.

cred_name
required
string

Credential name.

Responses

Response samples

Content type
application/json
Example
{
  • "name": "string",
  • "supportedLanguages": [
    ],
  • "bucket": "string",
  • "region": "string",
  • "credentials": {
    },
  • "credentialType": "S3"
}

Repository credentials with the given name.

Delete repository credentials with the given name.

path Parameters
repo_id
required
string

Repository identifier.

cred_name
required
string

Credential name.

Responses

Response samples

Content type
application/json
{}

Repository credentials access.

Check repository credentials access.

path Parameters
repo_id
required
string

Repository identifier.

cred_name
required
string

Credential name.

Responses

Response samples

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

Repository secrets.

Get all secrets of the given repository.

path Parameters
repo_id
required
string

Repository identifier.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

New repository secrets.

Create new repository secrets

path Parameters
repo_id
required
string

Repository identifier.

Request Body schema: application/json

credentials definition

name
required
string
bucket
required
string
region
string
object

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "bucket": "string",
  • "region": "string",
  • "credentials": {
    },
  • "credentialType": "S3"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "credentialType": "string",
  • "supportedLanguages": [
    ]
}

Update repository secret with the given name.

Update repository secret with the given name.

path Parameters
repo_id
required
string

Repository identifier.

Request Body schema: application/json

secret patch definition

name
required
string
bucket
string
region
string or null
object or null

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "bucket": "string",
  • "region": "string",
  • "credentials": {
    },
  • "credentialType": "S3"
}

Response samples

Content type
application/json
Example
{}

Repository secret with the given credential name.

Get repository secret with the given name.

path Parameters
repo_id
required
string

Repository identifier.

secret_name
required
string

Secret name.

Responses

Response samples

Content type
application/json
Example
{
  • "name": "string",
  • "supportedLanguages": [
    ],
  • "bucket": "string",
  • "region": "string",
  • "credentials": {
    },
  • "credentialType": "S3"
}

Repository secret with the given name.

Delete repository secret with the given name.

path Parameters
repo_id
required
string

Repository identifier.

secret_name
required
string

Secret name.

Responses

Response samples

Content type
application/json
{}

Repository refresh tasks status.

Returns status regarding repository refresh tasks.

Responses

Response samples

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

endpoints

Available endpoints.

Returns list of available endpoints accessible by the user.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Available endpoints with details.

Returns list of available endpoints with details accessible by the user.

Responses

Response samples

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

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",
  • "locality": "string",
  • "security": {
    },
  • "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 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"
}

Download the open API specification for the organization endpoints.

Returns the open API spec for the organization endpoints.

query Parameters
file_format
string
Default: "json"
Enum: "json" "yml" "yaml"

Choose the file format for download. Accepts 'json', 'yml', or 'yaml' (default is json).

security_scheme
string
Default: "all"
Enum: "all" "bearer_auth" "api_key"

Choose the security scheme to include in the specification. Accepts 'all', 'bearer_auth', or 'api_key' (default is all).

filter_security
string
Enum: "private" "public"

Filter endpoints based on security level, accepting 'private' or 'public' (by default, both are included).

has_scopes
boolean

Filter private endpoints based on whether they have scopes or not. By default, all private endpoints are included.

include_scopes
Array of strings

Filter private endpoints by including only those that match any of the provided scopes.

exclude_scopes
Array of strings

Filter private endpoints by excluding those that match any of the provided scopes.

include_tags
Array of strings

Filter endpoints by including only those that match any of the provided tags.

exclude_tags
Array of strings

Filter endpoints by excluding those that match any of the provided tags.

search_string
string

Filter endpoints by searching for the specified string within the title, description, or path.

include_ids
Array of strings

Filter endpoints by providing a list of endpoint IDs.

Responses

local endpoints

Returns draft endpoint id for the given local endpoint.

Returns draft endpoint id for the given local endpoint.

path Parameters
endpoint_id
required
string

Local Endpoint identifier.

Responses

Response samples

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

Get the local repository of the organization, i.e. the repository that serves all local endpoints.

Returns the local repository of the organization.

Responses

Response samples

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

Get the template requirements of the specified GitHub repository.

Returns the template requirements of the specified GitHub repository.

path Parameters
repo_owner
required
string

The owner of the GitHub repository.

repo_name
required
string

The name of the GitHub repository.

query Parameters
branch
string

The branch of the GitHub repository.

Responses

Response samples

Content type
application/json
{
  • "template": "string",
  • "credentials": [
    ]
}

Deploy the template of the specified GitHub repository.

Deploys the template of the specified GitHub repository.

path Parameters
repo_owner
required
string

The owner of the GitHub repository.

repo_name
required
string

The name of the GitHub repository.

query Parameters
branch
string

The branch of the GitHub repository.

Responses

Response samples

Content type
application/json
{
  • "state": "PENDING",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "eventId": 0,
  • "eventType": "REFRESH_REPOSITORY"
}

draft endpoints

Available draft endpoints.

Returns list of available draft endpoints accessible by the user.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new draft endpoint.

Creates a draft endpoint.

Request Body schema: application/json

Local Endpoint definition

endpointId
string
draftEndpointId
string
exampleId
string
type
string
Default: "GET"
path
required
string (Path) ^\/([a-z0-9\-._~%!$&'()*+,;=:@\/]*)
title
required
string
description
required
string
tags
Array of strings
code
string
declaration
string
language
string
termsOfService
string
author
string
version
string
enabled
boolean
object (EndpointDeploymentSettings)
object (EndpointSecurity)
object (EndpointContact)
object (EndpointLicense)

Responses

Request samples

Content type
application/json
{
  • "endpointId": "string",
  • "draftEndpointId": "string",
  • "exampleId": "string",
  • "type": "GET",
  • "path": "string",
  • "title": "string",
  • "description": "string",
  • "tags": [
    ],
  • "code": "string",
  • "declaration": "string",
  • "language": "string",
  • "termsOfService": "string",
  • "author": "string",
  • "version": "string",
  • "enabled": true,
  • "deploymentSettings": {
    },
  • "security": {
    },
  • "contact": {
    },
  • "license": {
    }
}

Response samples

Content type
application/json
{
  • "endpointId": "string",
  • "draftEndpointId": "string",
  • "exampleId": "string",
  • "type": "GET",
  • "path": "string",
  • "title": "string",
  • "description": "string",
  • "tags": [
    ],
  • "code": "string",
  • "declaration": "string",
  • "language": "string",
  • "termsOfService": "string",
  • "author": "string",
  • "version": "string",
  • "enabled": true,
  • "deploymentSettings": {
    },
  • "security": {
    },
  • "contact": {
    },
  • "license": {
    },
  • "commitHash": "string",
  • "repositoryId": "string",
  • "branch": "string",
  • "repositoryUrl": "string",
  • "locality": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Update a draft endpoint.

Updates a draft endpoint.

Request Body schema: application/json

Endpoint definition

endpointId
string
draftEndpointId
string
exampleId
string
type
string
Default: "GET"
path
required
string (Path) ^\/([a-z0-9\-._~%!$&'()*+,;=:@\/]*)
title
required
string
description
required
string
tags
Array of strings
code
string
declaration
string
language
string
termsOfService
string
author
string
version
string
enabled
boolean
object (EndpointDeploymentSettings)
object (EndpointSecurity)
object (EndpointContact)
object (EndpointLicense)

Responses

Request samples

Content type
application/json
{
  • "endpointId": "string",
  • "draftEndpointId": "string",
  • "exampleId": "string",
  • "type": "GET",
  • "path": "string",
  • "title": "string",
  • "description": "string",
  • "tags": [
    ],
  • "code": "string",
  • "declaration": "string",
  • "language": "string",
  • "termsOfService": "string",
  • "author": "string",
  • "version": "string",
  • "enabled": true,
  • "deploymentSettings": {
    },
  • "security": {
    },
  • "contact": {
    },
  • "license": {
    }
}

Response samples

Content type
application/json
{
  • "endpointId": "string",
  • "draftEndpointId": "string",
  • "exampleId": "string",
  • "type": "GET",
  • "path": "string",
  • "title": "string",
  • "description": "string",
  • "tags": [
    ],
  • "code": "string",
  • "declaration": "string",
  • "language": "string",
  • "termsOfService": "string",
  • "author": "string",
  • "version": "string",
  • "enabled": true,
  • "deploymentSettings": {
    },
  • "security": {
    },
  • "contact": {
    },
  • "license": {
    },
  • "commitHash": "string",
  • "repositoryId": "string",
  • "branch": "string",
  • "repositoryUrl": "string",
  • "locality": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Schedules an unpublished draft endpoint for publishing.

Schedules an unpublished draft endpoint for publishing.

path Parameters
id
required
string

Draft Endpoint identifier.

Responses

Response samples

Content type
application/json
{
  • "endpointId": "string",
  • "draftEndpointId": "string",
  • "type": "GET",
  • "path": "string",
  • "title": "string",
  • "description": "string",
  • "tags": [
    ],
  • "commitHash": "string",
  • "repositoryId": "string",
  • "repositoryUrl": "string",
  • "branch": "string",
  • "locality": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "event": {
    }
}

Schedules an already published draft endpoint for republishing.

Schedules an already published draft endpoint for republishing.

path Parameters
id
required
string

Draft Endpoint identifier.

Responses

Response samples

Content type
application/json
{
  • "endpointId": "string",
  • "draftEndpointId": "string",
  • "type": "GET",
  • "path": "string",
  • "title": "string",
  • "description": "string",
  • "tags": [
    ],
  • "commitHash": "string",
  • "repositoryId": "string",
  • "repositoryUrl": "string",
  • "branch": "string",
  • "locality": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "event": {
    }
}

Get details of the specified draft endpoint.

Returns draft endpoint metadata for the specified ID.

path Parameters
id
required
string

Draft Endpoint identifier.

Responses

Response samples

Content type
application/json
{
  • "endpointId": "string",
  • "draftEndpointId": "string",
  • "exampleId": "string",
  • "type": "GET",
  • "path": "string",
  • "title": "string",
  • "description": "string",
  • "tags": [
    ],
  • "code": "string",
  • "declaration": "string",
  • "language": "string",
  • "termsOfService": "string",
  • "author": "string",
  • "version": "string",
  • "enabled": true,
  • "deploymentSettings": {
    },
  • "security": {
    },
  • "contact": {
    },
  • "license": {
    },
  • "commitHash": "string",
  • "repositoryId": "string",
  • "branch": "string",
  • "repositoryUrl": "string",
  • "locality": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Delete a draft endpoint.

Deletes a draft endpoint.

path Parameters
id
required
string

Draft Endpoint identifier.

Responses

Response samples

Content type
application/json
Example
{}

Get run configurations of the specified draft endpoint.

Returns run configurations of the specified draft endpoint.

path Parameters
draft_id
required
string

Draft Endpoint identifier.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new run configuration for the specified draft endpoint.

Creates a new run configuration for the specified draft endpoint.

path Parameters
draft_id
required
string

Draft Endpoint identifier.

Request Body schema: application/json

Run configuration definition

name
string

A human-readable name for the run configuration. This is optional.

required
object

Run parameter values for testing the endpoint

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "configuration": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "configurationValues": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get the specified run configuration of the specified draft endpoint.

Returns the specified run configuration of the specified draft endpoint.

path Parameters
id
required
string

Run Configuration identifier.

draft_id
required
string

Draft Endpoint identifier.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "configurationValues": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update the specified run configuration of the specified draft endpoint.

Updates the specified run configuration of the specified draft endpoint.

path Parameters
id
required
string

Run Configuration identifier.

draft_id
required
string

Draft Endpoint identifier.

Request Body schema: application/json

Run configuration definition

name
string

A human-readable name for the run configuration. This is optional.

required
object

Run parameter values for testing the endpoint

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "configuration": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "configurationValues": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get the specified run configuration of the specified draft endpoint.

Returns the specified run configuration of the specified draft endpoint.

path Parameters
id
required
string

Run Configuration identifier.

draft_id
required
string

Draft Endpoint identifier.

Responses

Response samples

Content type
application/json
{}

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" "text" "binary"

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
{ }

Deletes program.

Deletes program.

path Parameters
programId
required
string

Program ID.

Responses

Response samples

Content type
application/json
{}

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": {
    },
  • "runnable": {
    },
  • "comment": "string"
}

public endpoints

Available endpoints.

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

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",
  • "locality": "string",
  • "security": {
    },
  • "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 occurred 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.

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

path Parameters
repo_event_id
required
string

Repository event identifier.

Responses

Response samples

Content type
application/json
{
  • "state": "PENDING",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "eventId": 0,
  • "eventType": "REFRESH_REPOSITORY"
}

Repository event details.

Returns event details of the requested event.

path Parameters
repo_event_id
required
string

Repository event identifier.

Responses

Response samples

Content type
application/json
{
  • "state": "PENDING",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "eventId": 0,
  • "eventType": "REFRESH_REPOSITORY",
  • "errors": [
    ]
}

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 code event.

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

path Parameters
event_id
required
string

Code 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 organization.

Returns the installations of the current organization.

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"
}

Response samples

Content type
application/json
{}

Users with permissions.

Returns the users along with the permissions.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

invites users and adds permissions.

an admin sets up users and permissions for this organization. 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
[
  • {
    }
]

Response samples

Content type
application/json
Example
{}

activate a registered user.

a user has responded to an activation email.

path Parameters
user_email
required
string

User email identifier.

Responses

Response samples

Content type
application/json
{}

Deletes a user.

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

path Parameters
user_email
required
string

User identifier.

Responses

Response samples

Content type
application/json
{}

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": [
    ]
}

Response samples

Content type
application/json
Example
{}

activate/deactivate an API key

path Parameters
key_id
required
string

API Key identifier.

activate
required
boolean

activate/deactivate API key

Responses

Response samples

Content type
application/json
{}

delete API key

path Parameters
key_id
required
string

API Key identifier.

Responses

Response samples

Content type
application/json
{}

scopes

List scopes

Returns the list of defined scopes

Responses

Response samples

Content type
application/json
[
  • {
    }
]

quota

Organization's quota status.

Returns organization's quota limits and usage.

Responses

Response samples

Content type
application/json
{
  • "repositories": {
    },
  • "privateEndpoints": {
    },
  • "publicEndpoints": {
    },
  • "localEndpoints": {
    },
  • "remoteEndpoints": {
    },
  • "draftEndpoints": {
    },
  • "users": {
    },
  • "apiKeys": {
    },
  • "scopes": {
    },
  • "tags": {
    },
  • "totalEndpoints": {
    },
  • "rule": "string"
}

user settings

User settings.

Returns user settings

path Parameters
user_email
required
string

User identifier.

Responses

Response samples

Content type
application/json
{
  • "persona": "string",
  • "settings": {
    }
}

User settings.

Updates user settings

path Parameters
user_email
required
string

User identifier.

Request Body schema: application/json
required

Arbitrary JSON as user settings payload

non-empty
persona
string
object

Responses

Request samples

Content type
application/json
{
  • "persona": "string",
  • "settings": {
    }
}

Response samples

Content type
application/json
{}

User settings.

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

path Parameters
user_email
required
string

User identifier.

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": {
    },
  • "runnable": {
    },
  • "comment": "string"
}

Does an LSP code validation request for AI.

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": {
    },
  • "runnable": {
    },
  • "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"
}

Does the autocompletion LSP 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": [
    ]
}

Does the hover LSP request.

Given a code position, returns its type or documentation description.

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
{
  • "lspTooltip": {
    }
}

Does the go to definition LSP request.

Given a code position, returns the position of its definition.

Request Body schema: application/json

The position of token which definition is to be found

required
object (LspRequestProperties)
required
object (Position)

Responses

Request samples

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

Response samples

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

Does the rename LSP request.

Given the position of the token to be renamed returns the list of positions where this token is used.

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
{
  • "positions": [
    ]
}