Pause a Runtime

Pause a Runtime

POST 
https://api.cuemby.io/functions/v1/runtimes/:runtimeIdentifier/pause

Pause 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 (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)

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
idstring
The ID of the runtime history
namestring
projectIdstring
environmentIdstring
templateIdstring
statusTypestring
Default value: PAUSED
trafficstring
hostUrlstring
tagNamestring
dockerfilePathstring
portsstring
replicasstring
deployedAtstring
The date when the runtime was deployed or was created
createdAtstring
The date when the history was created
integration object
id
fullNamestring
urlRepostring
repositoryNamestring
environments object
idstring
namestring
instanceTypes object
idstring
namestring

Example (auto)

{
  "success": true,
  "timestamp": "2024-01-01T00:00:00.000Z",
  "statusCode": 200,
  "statusText": "Success",
  "message": "Message successfully",
  "localization": "someone-method:success",
  "data": {
    "id": "string",
    "name": "string",
    "projectId": "string",
    "environmentId": "string",
    "templateId": "string",
    "statusType": "PAUSED",
    "traffic": "string",
    "hostUrl": "string",
    "tagName": "string",
    "dockerfilePath": "string",
    "ports": "string",
    "replicas": "string",
    "deployedAt": "string",
    "createdAt": "string",
    "integration": {
      "fullName": "string",
      "urlRepo": "string",
      "repositoryName": "string"
    },
    "environments": {
      "id": "string",
      "name": "string"
    },
    "instanceTypes": {
      "id": "string",
      "name": "string"
    }
  }
}

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.Post, "https://api.cuemby.io/functions/v1/runtimes/:runtimeIdentifier/pause");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("x-api-key", "<x-api-key>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.cuemby.io/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

ResponseClear

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