Update and Deploy a Runtime

Update and Deploy a Runtime

PUT 
undefined/functions/v1/runtimes/:runtimeIdentifier

Update and Deploy a Runtime

Request

Path Parameters

runtimeIdentifier stringrequired

The runtime ID or Name

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 to update the runtime (Use this if you are not going to use the X-Project-Name)

X-Project-Name string

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

X-Environment-Id string

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

X-Environment-Name string

The Name of the environment to update the runtime (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
portsnumber[]required
instanceTypestringrequired
templateIdstringrequired
trafficTypestringrequired
integrationIdstringrequired
runtimeVariables object[]required
Array [
namestring
valuestring
secretVariable object
namestring
]
integration objectrequired
branchstring
urlRepostring
repositoryNamestring
fullnamestring
oneOf

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: ok
messagestring
Default value: Message successfully
localizationstring
Default value: someone-method:success
data object
idstring
The ID of the runtime history
projectIdstring
templateIdstring
environmentIdstring
instanceTypesIdstring
integrationIdstring
namestring
activeboolean
statusTypestring
Default value: ENABLED
dockerfilePathstring
portsarray
replicasnumber
trafficstring
integration object
id
fullNamestring
urlRepostring
repositoryNamestring
hostUrlstring
tagNamestring
createdAtstring
The date when the runtime was created
updatedAtstring
The date when the runtime was updated
domainIdstring
The ID of the domain
isContainerizedboolean
Indicates if the runtime is containerized.
sourceCodeLanguagestring
The source code language (NodeJS, Java, Python, Golang).
linkGitHashstring
The link to the git sha
Default value: https://{repo}/tree/{branch-or-tag}

Example (auto)

{
  "success": true,
  "timestamp": "2024-01-01T00:00:00.000Z",
  "statusCode": 200,
  "statusText": "ok",
  "message": "Message successfully",
  "localization": "someone-method:success",
  "data": {
    "id": "string",
    "projectId": "string",
    "templateId": "string",
    "environmentId": "string",
    "instanceTypesId": "string",
    "integrationId": "string",
    "name": "string",
    "active": true,
    "statusType": "ENABLED",
    "dockerfilePath": "string",
    "ports": [
      null
    ],
    "replicas": 0,
    "traffic": "string",
    "integration": {
      "fullName": "string",
      "urlRepo": "string",
      "repositoryName": "string"
    },
    "hostUrl": "string",
    "tagName": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "domainId": "string",
    "isContainerized": true,
    "sourceCodeLanguage": "string",
    "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"
}

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.Put, "undefined/functions/v1/runtimes/:runtimeIdentifier");
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\": \"string\",\n  \"templateId\": \"string\",\n  \"trafficType\": \"string\",\n  \"integrationId\": \"string\",\n  \"runtimeVariables\": [\n    {\n      \"name\": \"string\",\n      \"value\": \"string\",\n      \"secretVariable\": {\n        \"name\": \"string\"\n      }\n    }\n  ],\n  \"integration\": {\n    \"branch\": \"string\",\n    \"urlRepo\": \"string\",\n    \"repositoryName\": \"string\",\n    \"fullname\": \"string\"\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

runtimeIdentifier — pathrequired

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)
• contenerized-example
• no-contenerized-example

{
  "isContainerized": true,
  "dockerfile": "string",
  "sourceCodeLanguage": "string",
  "replicas": 0,
  "ports": [
    0
  ],
  "instanceType": "string",
  "templateId": "string",
  "trafficType": "string",
  "integrationId": "string",
  "runtimeVariables": [
    {
      "name": "string",
      "value": "string",
      "secretVariable": {
        "name": "string"
      }
    }
  ],
  "integration": {
    "branch": "string",
    "urlRepo": "string",
    "repositoryName": "string",
    "fullname": "string"
  }
}

ResponseClear

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