Create one runtime

Create one runtime

POST 
undefined/functions/v1/runtimes

Create one runtime

Request

Header Parameters

X-Organization-Id string

The ID of the organization (this parameter is not required when using API key authorization)

X-Project-Id string

The ID of the project (Use this if you are not going to use the X-Project-Name)

X-Project-Name string

The Name of the project (Use this if you are not going to use the X-Project-Id)

X-Environment-Id string

The ID of the environment (Use this if you are not going to use the X-Environment-Name)

X-Environment-Name string

The Name of the environment (Use this if you are not going to use the X-Environment-Id)

application/json

Bodyrequired

isContainerizedboolean
Indicates if the runtime is containerized.
dockerfilestring
Path to the Dockerfile (required if isContainerized is true).
Possible values: <= 255 characters
sourceCodeLanguagestring
The source code language (NodeJS, Java, Python, Golang). Required if isContainerized is false.
replicasnumberrequired
Possible values: >= 0 and <= 10
portsnumber[]required
Possible values: >= 1
instanceTypeuuidrequired
The ID of the instance type
templateIduuidrequired
The ID of the template existing in the project
trafficTypestringrequired
Possible values: [internal, external]
integrationIduuidrequired
The ID of the integration existing in the project
runtimeVariables object[]
Array of variables to be used in the template.
Array [
namestring
Name of the variable.
valuestring
Value of the variable. Null if secretVariableId is present.
encryptedboolean
Indicates if the variable is encrypted, only when secretVariableId is not provided.
secretVariableIdstring
ID of the secret variable. Only if value has no value.
]
integration objectrequired
oneOf
MOD1
MOD2

Responses

200

Success

application/json

Schema

Schema

successboolean
Default value: true
timestampstring
Default value: 2024-01-01T00:00:00.000Z
statusCodenumber
Default value: 200
statusTextstring
Default value: Success
messagestring
Default value: Message successfully
localizationstring
Default value: someone-method:success
data object
idstringrequired
Default value: 1231f891-5db6-419a-8a9c-3963b2bcb425
namestringrequired
Default value: runtime
linkGitHashstring
Default value: https://{repo}/tree/{branch-or-tag}

Example (auto)

{
  "success": true,
  "timestamp": "2024-01-01T00:00:00.000Z",
  "statusCode": 200,
  "statusText": "Success",
  "message": "Message successfully",
  "localization": "someone-method:success",
  "data": {
    "id": "1231f891-5db6-419a-8a9c-3963b2bcb425",
    "name": "runtime",
    "linkGitHash": "https://{repo}/tree/{branch-or-tag}"
  }
}

400

Bad Request

application/json

Schema

Schema

successboolean
Default value: false
dataobject
Default value: null
timestampstring
Default value: 2024-01-01T00:00:00.000Z
statusCodenumber
Default value: 400
statusTextstring
Default value: Bad Request
messagestring
Default value: Message Error
localizationstring
Default value: someone-method:error

Example (auto)

{
  "success": false,
  "data": {},
  "timestamp": "2024-01-01T00:00:00.000Z",
  "statusCode": 400,
  "statusText": "Bad Request",
  "message": "Message Error",
  "localization": "someone-method:error"
}

401

Unauthorized

application/json

Schema

Schema

successboolean
Default value: false
dataobject
Default value: null
timestampstring
Default value: 2024-01-01T00:00:00.000Z
statusCodenumber
Default value: 401
statusTextstring
Default value: Unauthorized
messagestring
Default value: Message Unauthorized
localizationstring
Default value: someone-method:error

Example (auto)

{
  "success": false,
  "data": {},
  "timestamp": "2024-01-01T00:00:00.000Z",
  "statusCode": 401,
  "statusText": "Unauthorized",
  "message": "Message Unauthorized",
  "localization": "someone-method:error"
}

403

Forbidden

application/json

Schema

Schema

successboolean
Default value: false
dataobject
Default value: null
timestampstring
Default value: 2024-01-01T00:00:00.000Z
statusCodenumber
Default value: 403
statusTextstring
Default value: Forbidden
messagestring
Default value: Message Forbidden
localizationstring
Default value: someone-method:error

Example (auto)

{
  "success": false,
  "data": {},
  "timestamp": "2024-01-01T00:00:00.000Z",
  "statusCode": 403,
  "statusText": "Forbidden",
  "message": "Message Forbidden",
  "localization": "someone-method:error"
}

404

Not Found

application/json

Schema

Schema

successboolean
Default value: false
dataobject
Default value: null
timestampstring
Default value: 2024-01-01T00:00:00.000Z
statusCodenumber
Default value: 404
statusTextstring
Default value: Not Found
messagestring
Default value: Message Not Found
localizationstring
Default value: someone-method:error

Example (auto)

{
  "success": false,
  "data": {},
  "timestamp": "2024-01-01T00:00:00.000Z",
  "statusCode": 404,
  "statusText": "Not Found",
  "message": "Message Not Found",
  "localization": "someone-method:error"
}

500

Internal Server Error

application/json

Schema

Schema

successboolean
Default value: false
dataobject
Default value: null
timestampstring
Default value: 2024-01-01T00:00:00.000Z
statusCodenumber
Default value: 500
statusTextstring
Default value: Internal Server Error
messagestring
Default value: Message Internal Server Error
localizationstring
Default value: someone-method:error

Example (auto)

{
  "success": false,
  "data": {},
  "timestamp": "2024-01-01T00:00:00.000Z",
  "statusCode": 500,
  "statusText": "Internal Server Error",
  "message": "Message Internal Server Error",
  "localization": "someone-method:error"
}

503

Service Unavailable

application/json

Schema

Schema

successboolean
Default value: false
dataobject
Default value: null
timestampstring
Default value: 2024-01-01T00:00:00.000Z
statusCodenumber
Default value: 503
statusTextstring
Default value: Service Unavailable
messagestring
Default value: Message Service Unavailable
localizationstring
Default value: someone-method:error

Example (auto)

{
  "success": false,
  "data": {},
  "timestamp": "2024-01-01T00:00:00.000Z",
  "statusCode": 503,
  "statusText": "Service Unavailable",
  "message": "Message Service Unavailable",
  "localization": "someone-method:error"
}

Authorization: x-api-key

name: x-api-keytype: apiKeyin: header

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "undefined/functions/v1/runtimes");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("x-api-key", "<x-api-key>");
var content = new StringContent("{\n  \"isContainerized\": true,\n  \"dockerfile\": \"string\",\n  \"sourceCodeLanguage\": \"string\",\n  \"replicas\": 0,\n  \"ports\": [\n    0\n  ],\n  \"instanceType\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"templateId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"trafficType\": \"internal\",\n  \"integrationId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"runtimeVariables\": [\n    {\n      \"name\": \"string\",\n      \"value\": \"string\",\n      \"encrypted\": true,\n      \"secretVariableId\": \"string\"\n    }\n  ]\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

undefined/functions/v1

Auth

apiKeyAuth

Parameters

X-Organization-Id — header

X-Project-Id — header

X-Project-Name — header

X-Environment-Id — header

X-Environment-Name — header

Body required

• Example (from schema)
• containerized-example
• non-containerized-example

{
  "isContainerized": true,
  "dockerfile": "string",
  "sourceCodeLanguage": "string",
  "replicas": 0,
  "ports": [
    0
  ],
  "instanceType": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "templateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "trafficType": "internal",
  "integrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "runtimeVariables": [
    {
      "name": "string",
      "value": "string",
      "encrypted": true,
      "secretVariableId": "string"
    }
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!