apify-docs/apify-api/openapi/components/objects/actors/acts@{actorId}@versions@{versionNumber}@env-vars@{envVarName}put.yaml at 58d956696dc1d6b2cea1aaa65de7122186d43e07 · apify/apify-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
shared: &shared
  tags:
    - Actors/Actor versions
  parameters:
    - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId"
    - $ref: "../../parameters/runAndBuildParameters.yaml#/versionNumber"
    - name: envVarName
      in: path
      description: The name of the environment variable
      required: true
      style: simple
      schema:
        type: string
        example: MY_ENV_VAR
  requestBody:
    description: ""
    content:
      application/json:
        schema:
          $ref: ../../schemas/actors/EnvVarRequest.yaml
        example:
          name: MY_ENV_VAR
          value: my-new-value
          isSecret: false
    required: true
  responses:
    "200":
      description: ""
      headers: {}
      content:
        application/json:
          schema:
            $ref: ../../schemas/actors/EnvVarResponse.yaml
          example:
            data:
              name: MY_ENV_VAR
              value: my-value
              isSecret: false
    "400":
      $ref: ../../responses/BadRequest.yaml
    "401":
      $ref: ../../responses/Unauthorized.yaml
    "403":
      $ref: ../../responses/Forbidden.yaml
    "404":
      $ref: ../../responses/NotFound.yaml
    "405":
      $ref: ../../responses/MethodNotAllowed.yaml
    "413":
      $ref: ../../responses/PayloadTooLarge.yaml
    "415":
      $ref: ../../responses/UnsupportedMediaType.yaml
    "429":
      $ref: ../../responses/TooManyRequests.yaml
  deprecated: false
  x-py-parent: ActorEnvVarClientAsync
  x-py-name: update
  x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorEnvVarClientAsync#update

put:
  <<: *shared
  summary: Update environment variable
  description: |
    Updates Actor environment variable using values specified by a [EnvVar
    object](#/reference/actors/environment-variable-object)
    passed as JSON in the POST payload.
    If the object does not define a specific property, its value will not be
    updated.

    The request needs to specify the `Content-Type: application/json` HTTP
    header!

    When providing your API authentication token, we recommend using the
    request's `Authorization` header, rather than the URL. ([More
    info](#/introduction/authentication)).

    The response is the [EnvVar object](#/reference/actors/environment-variable-object) as returned by the
    [Get environment variable](#/reference/actors/environment-variable-object/get-environment-variable)
    endpoint.
  operationId: act_version_envVar_put
  x-legacy-doc-urls:
    - https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable
    - https://docs.apify.com/api/v2#/reference/actors/update-environment-variable
    - https://docs.apify.com/api/v2#tag/ActorsEnvironment-variable-object/operation/act_version_envVar_put

post:
  <<: *shared
  summary: Update environment variable (POST)
  description: |
    Updates Actor environment variable using values specified by a [EnvVar
    object](#/reference/actors/environment-variable-object)
    passed as JSON in the POST payload.
    This endpoint is an alias for the [`PUT` update environment variable](#tag/ActorsEnvironment-variable-object/operation/act_version_envVar_put) method and behaves identically.
  operationId: act_version_envVar_post
  x-legacy-doc-urls:
    - https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable
    - https://docs.apify.com/api/v2#/reference/actors/update-environment-variable
    - https://docs.apify.com/api/v2#tag/ActorsEnvironment-variable-object/operation/act_version_envVar_post