Create a Secret or Variable

Create a Secret or Variable

POST 
undefined/functions/v1/secrets-variables

Create a Secret or Variable

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 stringrequired

The ID of the project to create the secret or variable

application/json

Bodyrequired

namestringrequired
Possible values: non-empty and <= 100 characters, Value must match regular expression ^[a-zA-Z].*$
valuestringrequired
Possible values: Value must match regular expression ^(|[a-zA-Z0-9].*)$
itemTypestringrequired
Possible values: [secret, variable]
descriptionstring
Possible values: <= 255 characters, Value must match regular expression ^(|[a-zA-Z0-9].*)$
wildCardstring
Possible values: <= 255 characters, Value must match regular expression ^(%?[a-zA-Z0-9-_]*%?|)$
environmentIdstring

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: Created
messagestring
Default value: Message successfully
localizationstring
Default value: someone-method:success
dataobject

Example (auto)

{
  "success": true,
  "timestamp": "2024-01-01T00:00:00.000Z",
  "statusCode": 200,
  "statusText": "Created",
  "message": "Message successfully",
  "localization": "someone-method:success",
  "data": {}
}

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, "undefined/functions/v1/secrets-variables");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("x-api-key", "<x-api-key>");
var content = new StringContent("{\n  \"name\": \"string\",\n  \"value\": \"string\",\n  \"itemType\": \"secret\",\n  \"description\": \"string\",\n  \"wildCard\": \"string\",\n  \"environmentId\": \"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

X-Project-Id — headerrequired

X-Organization-Id — header

Body required

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

{
  "name": "string",
  "value": "string",
  "itemType": "secret",
  "description": "string",
  "wildCard": "string",
  "environmentId": "string"
}

ResponseClear

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