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
- Payload
{- "name": "string",
- "bucket": "string",
- "region": "string",
- "credentials": {
- "accessKey": "pa$$word",
- "secretKey": "pa$$word"
}, - "credentialType": "S3"
}
Response samples
- 201
- 400
- 401
- 403
- 404
{- "name": "string",
- "credentialType": "string",
- "supportedLanguages": [
- "string"
]
}
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
- Payload
{- "name": "string",
- "bucket": "string",
- "region": "string",
- "credentials": {
- "accessKey": "pa$$word",
- "secretKey": "pa$$word"
}, - "credentialType": "S3"
}
Response samples
- 400
- 401
- 403
- 404
{- "title": "Forbidden",
- "status": 403,
- "detail": "Access to the requested resource is forbidden.",
- "timestamp": "2019-08-24T14:15:22Z",
- "errorCode": "ForbiddenError"
}
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
- 200
- 401
- 403
- 404
{- "name": "string",
- "supportedLanguages": [
- "string"
], - "bucket": "string",
- "region": "string",
- "credentials": {
- "accessKey": "pa$$word",
- "secretKey": "pa$$word"
}, - "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
- 401
- 403
- 404
{- "title": "Api Key Not Found",
- "status": 401,
- "detail": "Request lacks valid authentication credentials",
- "timestamp": "2019-08-24T14:15:22Z",
- "errorCode": "ApiKeyNotFoundError"
}
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
- Payload
{- "name": "string",
- "bucket": "string",
- "region": "string",
- "credentials": {
- "accessKey": "pa$$word",
- "secretKey": "pa$$word"
}, - "credentialType": "S3"
}
Response samples
- 201
- 400
- 401
- 403
- 404
{- "name": "string",
- "credentialType": "string",
- "supportedLanguages": [
- "string"
]
}
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
- Payload
{- "name": "string",
- "bucket": "string",
- "region": "string",
- "credentials": {
- "accessKey": "pa$$word",
- "secretKey": "pa$$word"
}, - "credentialType": "S3"
}
Response samples
- 400
- 401
- 403
- 404
{- "title": "Forbidden",
- "status": 403,
- "detail": "Access to the requested resource is forbidden.",
- "timestamp": "2019-08-24T14:15:22Z",
- "errorCode": "ForbiddenError"
}
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
- 200
- 401
- 403
- 404
{- "name": "string",
- "supportedLanguages": [
- "string"
], - "bucket": "string",
- "region": "string",
- "credentials": {
- "accessKey": "pa$$word",
- "secretKey": "pa$$word"
}, - "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
- 401
- 403
- 404
{- "title": "Api Key Not Found",
- "status": 401,
- "detail": "Request lacks valid authentication credentials",
- "timestamp": "2019-08-24T14:15:22Z",
- "errorCode": "ApiKeyNotFoundError"
}
Response samples
- 200
[- {
- "endpointId": "string",
- "repositoryUrl": "string",
- "path": "string",
- "branch": "string",
- "title": "string",
- "description": "string",
- "locality": "string",
- "security": {
- "visibility": true,
- "scopes": [
- "string"
]
}, - "tags": [
- "string"
]
}
]
Available endpoints with details.
Returns list of available endpoints with details accessible by the user.
Responses
Response samples
- 200
{- "endpoints": [
- {
- "endpointId": "string",
- "repositoryUrl": "string",
- "path": "string",
- "branch": "string",
- "title": "string",
- "description": "string",
- "locality": "string",
- "security": {
- "visibility": true,
- "scopes": [
- "string"
]
}, - "tags": [
- "string"
], - "termsOfService": "string",
- "author": "string",
- "contact": {
- "name": "string",
- "email": "user@example.com",
- "url": "string"
}, - "license": {
- "name": "string",
- "url": "string"
}, - "version": "string"
}
]
}
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
- 200
{- "endpointId": "string",
- "repositoryUrl": "string",
- "path": "string",
- "branch": "string",
- "title": "string",
- "description": "string",
- "locality": "string",
- "security": {
- "visibility": true,
- "scopes": [
- "string"
]
}, - "tags": [
- "string"
], - "termsOfService": "string",
- "author": "string",
- "contact": {
- "name": "string",
- "email": "user@example.com",
- "url": "string"
}, - "license": {
- "name": "string",
- "url": "string"
}, - "version": "string",
- "code": "string",
- "language": "string",
- "outputType": "string",
- "outputFormat": "csv",
- "parameters": [
- {
- "name": "string",
- "type": "string",
- "defaultValue": "string"
}
], - "type": "GET"
}
Endpoint deployment settings.
Returns deployment settings of an endpoint.
path Parameters
endpoint_id required | string Endpoint identifier. |
Responses
Response samples
- 200
{- "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
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
- 200
- 400
- 401
- 403
- 404
{- "template": "string",
- "credentials": [
- {
- "name": "string",
- "type": "string",
- "exists": true,
- "isValid": true
}
]
}
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
- 202
- 401
- 403
- 404
{- "state": "PENDING",
- "timestamp": "2019-08-24T14:15:22Z",
- "eventId": 0,
- "eventType": "REFRESH_REPOSITORY"
}
Available draft endpoints.
Returns list of available draft endpoints accessible by the user.
Responses
Response samples
- 200
[- {
- "endpointId": "string",
- "draftEndpointId": "string",
- "exampleId": "string",
- "type": "GET",
- "path": "string",
- "title": "string",
- "description": "string",
- "tags": [
- "string"
], - "code": "string",
- "declaration": "string",
- "language": "string",
- "termsOfService": "string",
- "author": "string",
- "version": "string",
- "enabled": true,
- "deploymentSettings": {
- "computeClass": "string",
- "computeCacheSizeMb": 0,
- "computeLimitSeconds": 0,
- "expireSeconds": 0,
- "format": "string"
}, - "security": {
- "visibility": true,
- "scopes": [
- "string"
]
}, - "contact": {
- "name": "string",
- "email": "user@example.com",
- "url": "string"
}, - "license": {
- "name": "string",
- "url": "string"
}, - "commitHash": "string",
- "repositoryId": "string",
- "branch": "string",
- "repositoryUrl": "string",
- "locality": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}
]
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
- Payload
{- "endpointId": "string",
- "draftEndpointId": "string",
- "exampleId": "string",
- "type": "GET",
- "path": "string",
- "title": "string",
- "description": "string",
- "tags": [
- "string"
], - "code": "string",
- "declaration": "string",
- "language": "string",
- "termsOfService": "string",
- "author": "string",
- "version": "string",
- "enabled": true,
- "deploymentSettings": {
- "computeClass": "string",
- "computeCacheSizeMb": 0,
- "computeLimitSeconds": 0,
- "expireSeconds": 0,
- "format": "string"
}, - "security": {
- "visibility": true,
- "scopes": [
- "string"
]
}, - "contact": {
- "name": "string",
- "email": "user@example.com",
- "url": "string"
}, - "license": {
- "name": "string",
- "url": "string"
}
}
Response samples
- 202
- 400
- 401
- 403
{- "endpointId": "string",
- "draftEndpointId": "string",
- "exampleId": "string",
- "type": "GET",
- "path": "string",
- "title": "string",
- "description": "string",
- "tags": [
- "string"
], - "code": "string",
- "declaration": "string",
- "language": "string",
- "termsOfService": "string",
- "author": "string",
- "version": "string",
- "enabled": true,
- "deploymentSettings": {
- "computeClass": "string",
- "computeCacheSizeMb": 0,
- "computeLimitSeconds": 0,
- "expireSeconds": 0,
- "format": "string"
}, - "security": {
- "visibility": true,
- "scopes": [
- "string"
]
}, - "contact": {
- "name": "string",
- "email": "user@example.com",
- "url": "string"
}, - "license": {
- "name": "string",
- "url": "string"
}, - "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
- Payload
{- "endpointId": "string",
- "draftEndpointId": "string",
- "exampleId": "string",
- "type": "GET",
- "path": "string",
- "title": "string",
- "description": "string",
- "tags": [
- "string"
], - "code": "string",
- "declaration": "string",
- "language": "string",
- "termsOfService": "string",
- "author": "string",
- "version": "string",
- "enabled": true,
- "deploymentSettings": {
- "computeClass": "string",
- "computeCacheSizeMb": 0,
- "computeLimitSeconds": 0,
- "expireSeconds": 0,
- "format": "string"
}, - "security": {
- "visibility": true,
- "scopes": [
- "string"
]
}, - "contact": {
- "name": "string",
- "email": "user@example.com",
- "url": "string"
}, - "license": {
- "name": "string",
- "url": "string"
}
}
Response samples
- 202
- 400
- 401
- 403
{- "endpointId": "string",
- "draftEndpointId": "string",
- "exampleId": "string",
- "type": "GET",
- "path": "string",
- "title": "string",
- "description": "string",
- "tags": [
- "string"
], - "code": "string",
- "declaration": "string",
- "language": "string",
- "termsOfService": "string",
- "author": "string",
- "version": "string",
- "enabled": true,
- "deploymentSettings": {
- "computeClass": "string",
- "computeCacheSizeMb": 0,
- "computeLimitSeconds": 0,
- "expireSeconds": 0,
- "format": "string"
}, - "security": {
- "visibility": true,
- "scopes": [
- "string"
]
}, - "contact": {
- "name": "string",
- "email": "user@example.com",
- "url": "string"
}, - "license": {
- "name": "string",
- "url": "string"
}, - "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
- 202
- 400
- 401
- 403
{- "endpointId": "string",
- "draftEndpointId": "string",
- "type": "GET",
- "path": "string",
- "title": "string",
- "description": "string",
- "tags": [
- "string"
], - "commitHash": "string",
- "repositoryId": "string",
- "repositoryUrl": "string",
- "branch": "string",
- "locality": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "event": {
- "state": "PENDING",
- "timestamp": "2019-08-24T14:15:22Z",
- "eventId": 0,
- "eventType": "REFRESH_REPOSITORY"
}
}
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
- 202
- 400
- 401
- 403
{- "endpointId": "string",
- "draftEndpointId": "string",
- "type": "GET",
- "path": "string",
- "title": "string",
- "description": "string",
- "tags": [
- "string"
], - "commitHash": "string",
- "repositoryId": "string",
- "repositoryUrl": "string",
- "branch": "string",
- "locality": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "event": {
- "state": "PENDING",
- "timestamp": "2019-08-24T14:15:22Z",
- "eventId": 0,
- "eventType": "REFRESH_REPOSITORY"
}
}
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
- 200
{- "endpointId": "string",
- "draftEndpointId": "string",
- "exampleId": "string",
- "type": "GET",
- "path": "string",
- "title": "string",
- "description": "string",
- "tags": [
- "string"
], - "code": "string",
- "declaration": "string",
- "language": "string",
- "termsOfService": "string",
- "author": "string",
- "version": "string",
- "enabled": true,
- "deploymentSettings": {
- "computeClass": "string",
- "computeCacheSizeMb": 0,
- "computeLimitSeconds": 0,
- "expireSeconds": 0,
- "format": "string"
}, - "security": {
- "visibility": true,
- "scopes": [
- "string"
]
}, - "contact": {
- "name": "string",
- "email": "user@example.com",
- "url": "string"
}, - "license": {
- "name": "string",
- "url": "string"
}, - "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
- 400
- 401
- 403
{- "title": "Forbidden",
- "status": 403,
- "detail": "Access to the requested resource is forbidden.",
- "timestamp": "2019-08-24T14:15:22Z",
- "errorCode": "ForbiddenError"
}
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
- 200
- 401
- 403
- 404
[- {
- "id": "string",
- "name": "string",
- "configurationValues": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
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
- Payload
{- "name": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}
}
Response samples
- 201
- 400
- 401
- 403
- 404
{- "id": "string",
- "name": "string",
- "configurationValues": {
- "property1": "string",
- "property2": "string"
}, - "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
- 200
- 401
- 403
- 404
{- "id": "string",
- "name": "string",
- "configurationValues": {
- "property1": "string",
- "property2": "string"
}, - "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
- Payload
{- "name": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}
}
Response samples
- 201
- 400
- 401
- 403
{- "id": "string",
- "name": "string",
- "configurationValues": {
- "property1": "string",
- "property2": "string"
}, - "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
- 401
- 403
- 404
{- "title": "Api Key Not Found",
- "status": 401,
- "detail": "Request lacks valid authentication credentials",
- "timestamp": "2019-08-24T14:15:22Z",
- "errorCode": "ApiKeyNotFoundError"
}
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
- Payload
{- "repositoryReference": {
- "repoId": 0
}, - "language": "string",
- "code": "string",
- "declaration": "string",
- "arguments": {
- "property1": "string",
- "property2": "string"
}, - "computeClass": "string",
- "computeLimitSeconds": 1,
- "outputFormat": "csv"
}
Response samples
- 202
- 400
- 401
- 403
{- "id": "string"
}
Response samples
- 401
- 403
- 404
{- "title": "Api Key Not Found",
- "status": 401,
- "detail": "Request lacks valid authentication credentials",
- "timestamp": "2019-08-24T14:15:22Z",
- "errorCode": "ApiKeyNotFoundError"
}
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
- Payload
{- "repositoryReference": {
- "repoId": 0
}, - "language": "string",
- "code": "string"
}
Response samples
- 200
- 400
- 401
- 403
{- "declarations": {
- "property1": [
- {
- "parameters": [
- {
- "identifier": "string",
- "tipe": "string",
- "required": true
}
], - "outputType": "string",
- "comment": "string"
}
], - "property2": [
- {
- "parameters": [
- {
- "identifier": "string",
- "tipe": "string",
- "required": true
}
], - "outputType": "string",
- "comment": "string"
}
]
}, - "runnable": {
- "parameters": [
- {
- "identifier": "string",
- "tipe": "string",
- "required": true
}
], - "outputType": "string",
- "comment": "string"
}, - "comment": "string"
}
Available endpoints.
Returns list of available of endpoints accessible by the user with publicly visible information.
Responses
Response samples
- 200
[- {
- "endpointId": "string",
- "repositoryUrl": "string",
- "path": "string",
- "branch": "string",
- "title": "string",
- "description": "string",
- "locality": "string",
- "security": {
- "visibility": true,
- "scopes": [
- "string"
]
}, - "tags": [
- "string"
]
}
]
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
- 200
- 401
- 403
- 404
{- "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
- 401
- 403
- 404
{- "title": "Api Key Not Found",
- "status": 401,
- "detail": "Request lacks valid authentication credentials",
- "timestamp": "2019-08-24T14:15:22Z",
- "errorCode": "ApiKeyNotFoundError"
}
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
- 200
- 401
- 403
- 404
{- "endpointId": "string",
- "repositoryUrl": "string",
- "path": "string",
- "branch": "string",
- "title": "string",
- "description": "string",
- "locality": "string",
- "security": {
- "visibility": true,
- "scopes": [
- "string"
]
}, - "tags": [
- "string"
], - "termsOfService": "string",
- "author": "string",
- "contact": {
- "name": "string",
- "email": "user@example.com",
- "url": "string"
}, - "license": {
- "name": "string",
- "url": "string"
}, - "version": "string",
- "code": "string",
- "language": "string",
- "outputType": "string",
- "outputFormat": "csv",
- "parameters": [
- {
- "name": "string",
- "type": "string",
- "defaultValue": "string"
}
], - "type": "GET"
}
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
- 200
- 400
- 401
- 403
- 404
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
- 200
- 400
- 401
- 403
- 404
{- "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
- 200
- 400
- 401
- 403
- 404
{- "state": "PENDING",
- "timestamp": "2019-08-24T14:15:22Z",
- "eventId": 0,
- "eventType": "REFRESH_REPOSITORY",
- "errors": [
- "string"
]
}
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
- 200
- 400
- 401
- 403
- 404
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
- 200
- 400
- 401
- 403
- 404
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
- 200
- 400
- 401
- 403
- 404
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
- 200
- 400
- 401
- 403
- 404
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
- 200
- 401
- 403
- 404
{- "messages": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "level": "INFO",
- "message": "string",
- "positions": [
- {
- "begin": {
- "line": 0,
- "column": 0
}, - "end": {
- "line": 0,
- "column": 0
}
}
]
}
]
}
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
- 200
- 401
- 403
- 404
{- "messages": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "level": "INFO",
- "message": "string",
- "positions": [
- {
- "begin": {
- "line": 0,
- "column": 0
}, - "end": {
- "line": 0,
- "column": 0
}
}
]
}
]
}
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
- 200
- 400
- 401
- 403
- 404
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
- 200
- 400
- 401
- 403
- 404
null
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
- Payload
{- "producerRoles": "string",
- "consumerScopes": "string"
}
Response samples
- 401
- 403
- 404
{- "title": "Api Key Not Found",
- "status": 401,
- "detail": "Request lacks valid authentication credentials",
- "timestamp": "2019-08-24T14:15:22Z",
- "errorCode": "ApiKeyNotFoundError"
}
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
producerRoles required | string |
consumerScopes required | string |
account required | string |
Responses
Request samples
- Payload
[- {
- "producerRoles": "string",
- "consumerScopes": "string",
- "account": "string"
}
]
Response samples
- 400
- 401
- 403
{- "title": "Forbidden",
- "status": 403,
- "detail": "Access to the requested resource is forbidden.",
- "timestamp": "2019-08-24T14:15:22Z",
- "errorCode": "ForbiddenError"
}
activate a registered user.
a user has responded to an activation email.
path Parameters
user_email required | string User email identifier. |
Responses
Response samples
- 401
- 403
- 404
{- "title": "Api Key Not Found",
- "status": 401,
- "detail": "Request lacks valid authentication credentials",
- "timestamp": "2019-08-24T14:15:22Z",
- "errorCode": "ApiKeyNotFoundError"
}
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
- 401
- 403
- 404
{- "title": "Api Key Not Found",
- "status": 401,
- "detail": "Request lacks valid authentication credentials",
- "timestamp": "2019-08-24T14:15:22Z",
- "errorCode": "ApiKeyNotFoundError"
}
Response samples
- 200
- 401
- 403
[- {
- "id": "string",
- "name": "string",
- "key": "string",
- "active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "expires_at": "2019-08-24T14:15:22Z",
- "scopes": [
- {
- "id": "string",
- "value": "string",
- "count": 0
}
]
}
]
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
- Payload
{- "expires_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "active": true,
- "scopes": [
- {
- "id": "string",
- "value": "string",
- "count": 0
}
]
}
Response samples
- 400
- 401
- 403
{- "title": "Forbidden",
- "status": 403,
- "detail": "Access to the requested resource is forbidden.",
- "timestamp": "2019-08-24T14:15:22Z",
- "errorCode": "ForbiddenError"
}
activate/deactivate an API key
path Parameters
key_id required | string API Key identifier. |
activate required | boolean activate/deactivate API key |
Responses
Response samples
- 401
- 403
- 404
{- "title": "Api Key Not Found",
- "status": 401,
- "detail": "Request lacks valid authentication credentials",
- "timestamp": "2019-08-24T14:15:22Z",
- "errorCode": "ApiKeyNotFoundError"
}
Response samples
- 401
- 403
- 404
{- "title": "Api Key Not Found",
- "status": 401,
- "detail": "Request lacks valid authentication credentials",
- "timestamp": "2019-08-24T14:15:22Z",
- "errorCode": "ApiKeyNotFoundError"
}
Response samples
- 200
- 401
- 403
- 404
{- "repositories": {
- "current": 0,
- "limit": 0
}, - "privateEndpoints": {
- "current": 0,
- "limit": 0
}, - "publicEndpoints": {
- "current": 0,
- "limit": 0
}, - "localEndpoints": {
- "current": 0,
- "limit": 0
}, - "remoteEndpoints": {
- "current": 0,
- "limit": 0
}, - "draftEndpoints": {
- "current": 0,
- "limit": 0
}, - "users": {
- "current": 0,
- "limit": 0
}, - "apiKeys": {
- "current": 0,
- "limit": 0
}, - "scopes": {
- "current": 0,
- "limit": 0
}, - "tags": {
- "current": 0,
- "limit": 0
}, - "totalEndpoints": {
- "current": 0,
- "limit": 0
}, - "rule": "string"
}
User settings.
Updates user settings
path Parameters
user_email required | string User identifier. |
Request Body schema: application/jsonrequired
Arbitrary JSON as user settings payload
persona | string |
object |
Responses
Request samples
- Payload
{- "persona": "string",
- "settings": {
- "property1": { },
- "property2": { }
}
}
Response samples
- 401
- 403
- 404
{- "title": "Api Key Not Found",
- "status": 401,
- "detail": "Request lacks valid authentication credentials",
- "timestamp": "2019-08-24T14:15:22Z",
- "errorCode": "ApiKeyNotFoundError"
}
User settings.
Delete the user along with all the permissions he/she owns.
path Parameters
user_email required | string User identifier. |
Responses
Response samples
- 401
- 403
- 404
{- "title": "Api Key Not Found",
- "status": 401,
- "detail": "Request lacks valid authentication credentials",
- "timestamp": "2019-08-24T14:15:22Z",
- "errorCode": "ApiKeyNotFoundError"
}
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) | ||||||||
|
Responses
Request samples
- Payload
{- "lspRequestProperties": {
- "repositoryReference": {
- "repoId": 0
}, - "language": "string",
- "code": "string",
- "options": {
- "property1": "string",
- "property2": "string"
}
}
}
Response samples
- 200
- 400
- 401
- 403
{- "declarations": {
- "property1": [
- {
- "parameters": [
- {
- "identifier": "string",
- "tipe": "string",
- "required": true
}
], - "outputType": "string",
- "comment": "string"
}
], - "property2": [
- {
- "parameters": [
- {
- "identifier": "string",
- "tipe": "string",
- "required": true
}
], - "outputType": "string",
- "comment": "string"
}
]
}, - "runnable": {
- "parameters": [
- {
- "identifier": "string",
- "tipe": "string",
- "required": true
}
], - "outputType": "string",
- "comment": "string"
}, - "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) | ||||||||
|
Responses
Request samples
- Payload
{- "lspRequestProperties": {
- "repositoryReference": {
- "repoId": 0
}, - "language": "string",
- "code": "string",
- "options": {
- "property1": "string",
- "property2": "string"
}
}
}
Response samples
- 200
- 400
- 401
- 403
{- "declarations": {
- "property1": [
- {
- "parameters": [
- {
- "identifier": "string",
- "tipe": "string",
- "required": true
}
], - "outputType": "string",
- "comment": "string"
}
], - "property2": [
- {
- "parameters": [
- {
- "identifier": "string",
- "tipe": "string",
- "required": true
}
], - "outputType": "string",
- "comment": "string"
}
]
}, - "runnable": {
- "parameters": [
- {
- "identifier": "string",
- "tipe": "string",
- "required": true
}
], - "outputType": "string",
- "comment": "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
- Payload
{- "lspRequestProperties": {
- "repositoryReference": {
- "repoId": 0
}, - "language": "string",
- "code": "string",
- "options": {
- "property1": "string",
- "property2": "string"
}
}, - "numberOfSpaces": 0,
- "useTabs": true
}
Response samples
- 200
- 401
- 403
{- "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
- Payload
{- "lspRequestProperties": {
- "repositoryReference": {
- "repoId": 0
}, - "language": "string",
- "code": "string",
- "options": {
- "property1": "string",
- "property2": "string"
}
}, - "triggeringChar": "string",
- "position": {
- "line": 0,
- "column": 0
}
}
Response samples
- 200
- 401
- 403
{- "autocompletionItems": [
- {
- "name": "string",
- "autoCompleteType": 0,
- "lspTooltip": {
- "name": "string",
- "description": "string",
- "info": "string",
- "warning": "string",
- "danger": "string"
}
}
]
}
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
- Payload
{- "lspRequestProperties": {
- "repositoryReference": {
- "repoId": 0
}, - "language": "string",
- "code": "string",
- "options": {
- "property1": "string",
- "property2": "string"
}
}, - "position": {
- "line": 0,
- "column": 0
}
}
Response samples
- 200
- 401
- 403
{- "lspTooltip": {
- "name": "string",
- "description": "string",
- "info": "string",
- "warning": "string",
- "danger": "string"
}
}
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
- Payload
{- "lspRequestProperties": {
- "repositoryReference": {
- "repoId": 0
}, - "language": "string",
- "code": "string",
- "options": {
- "property1": "string",
- "property2": "string"
}
}, - "position": {
- "line": 0,
- "column": 0
}
}
Response samples
- 200
- 401
- 403
{- "position": {
- "line": 0,
- "column": 0
}
}
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
- Payload
{- "lspRequestProperties": {
- "repositoryReference": {
- "repoId": 0
}, - "language": "string",
- "code": "string",
- "options": {
- "property1": "string",
- "property2": "string"
}
}, - "position": {
- "line": 0,
- "column": 0
}
}
Response samples
- 200
- 401
- 403
{- "positions": [
- {
- "line": 0,
- "column": 0
}
]
}