Update one environment

Update one environment

PUT 
undefined/functions/v1/environments/:environmentIdentifier

Update one environment

Request

Path Parameters

environmentIdentifier stringrequired

The ID or Name of the environment

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)

application/json

Bodyrequired

namestringrequired

The name of the environment

Possible values: >= 3 characters and <= 30 characters, Value must match regular expression ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$

Responses

201

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
Default value: 1231f891-5db6-419a-8a9c-3963b2bcb425
namestring
Default value: Test organization
descriptionstring
Default value: test description

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": "Test organization",
    "description": "test description"
  }
}

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.Put, "undefined/functions/v1/environments/:environmentIdentifier");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("x-api-key", "<x-api-key>");
var content = new StringContent("{\n  \"name\": \"string\"\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

environmentIdentifier — pathrequired

X-Organization-Id — header

X-Project-Id — header

X-Project-Name — header

Body required

• Example (from schema)
• only-required-fields

{
  "name": "string"
}

ResponseClear

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