InfoGrab Docs

인스턴스 레벨 CI/CD 변수 API

요약

이 API를 사용하여 인스턴스의 CI/CD 변수와 상호 작용합니다. 모든 인스턴스 레벨 변수를 나열합니다. 특정 인스턴스 레벨 변수의 세부 정보를 가져옵니다. 최대 인스턴스 레벨 변수 수를 변경할 수 있습니다. 인스턴스 레벨 변수를 업데이트합니다.

이 API를 사용하여 인스턴스의 CI/CD 변수와 상호 작용합니다.

모든 인스턴스 변수 나열#

히스토리
  • GitLab 16.8에서 description 파라미터 도입됨.

모든 인스턴스 레벨 변수를 나열합니다. pageper_page 페이지화 파라미터를 사용하여 결과의 페이지화를 제어합니다.

GET /admin/ci/variables
curl \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/ci/variables"
[
    {
        "key": "TEST_VARIABLE_1",
        "description": null,
        "variable_type": "env_var",
        "value": "TEST_1",
        "protected": false,
        "masked": false,
        "raw": false
    },
    {
        "key": "TEST_VARIABLE_2",
        "description": null,
        "variable_type": "env_var",
        "value": "TEST_2",
        "protected": false,
        "masked": false,
        "raw": false
    }
]

인스턴스 변수 세부 정보 가져오기#

히스토리
  • GitLab 16.8에서 description 파라미터 도입됨.

특정 인스턴스 레벨 변수의 세부 정보를 가져옵니다.

GET /admin/ci/variables/:key
속성 유형 필수 여부 설명
key 문자열 Yes 변수의 key
curl \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/ci/variables/TEST_VARIABLE_1"
{
    "key": "TEST_VARIABLE_1",
    "description": null,
    "variable_type": "env_var",
    "value": "TEST_1",
    "protected": false,
    "masked": false,
    "raw": false
}

인스턴스 변수 만들기#

히스토리
  • GitLab 16.8에서 description 파라미터 도입됨.

새 인스턴스 레벨 변수를 만듭니다.

최대 인스턴스 레벨 변수 수를 변경할 수 있습니다.

POST /admin/ci/variables
속성 유형 필수 여부 설명
key 문자열 Yes 변수의 key. 최대 255자, A-Z, a-z, 0-9, _만 허용됩니다.
value 문자열 Yes 변수의 value. 최대 10,000자.
description 문자열 No 변수의 설명. 최대 255자.
masked 불리언 No 변수를 마스킹할지 여부.
protected 불리언 No 변수를 보호할지 여부.
raw 불리언 No 변수를 확장 가능하게 할지 여부.
variable_type 문자열 No 변수 유형. 사용 가능한 유형: env_var(기본값) 및 file.
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/ci/variables" \
  --form "key=NEW_VARIABLE" \
  --form "value=new value"
{
    "key": "NEW_VARIABLE",
    "description": null,
    "value": "new value",
    "variable_type": "env_var",
    "protected": false,
    "masked": false,
    "raw": false
}

인스턴스 변수 업데이트#

히스토리
  • GitLab 16.8에서 description 파라미터 도입됨.

인스턴스 레벨 변수를 업데이트합니다.

PUT /admin/ci/variables/:key
속성 유형 필수 여부 설명
description 문자열 No 변수의 설명. 최대 255자.
key 문자열 Yes 변수의 key. 최대 255자, A-Z, a-z, 0-9, _만 허용됩니다.
masked 불리언 No 변수를 마스킹할지 여부.
protected 불리언 No 변수를 보호할지 여부.
raw 불리언 No 변수를 확장 가능하게 할지 여부.
value 문자열 Yes 변수의 value. 최대 10,000자.
variable_type 문자열 No 변수 유형. 사용 가능한 유형: env_var(기본값) 및 file.
curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/ci/variables/NEW_VARIABLE" \
  --form "value=updated value"
{
    "key": "NEW_VARIABLE",
    "description": null,
    "value": "updated value",
    "variable_type": "env_var",
    "protected": true,
    "masked": true,
    "raw": true
}

인스턴스 변수 삭제#

인스턴스 레벨 변수를 삭제합니다.

DELETE /admin/ci/variables/:key
속성 유형 필수 여부 설명
key 문자열 Yes 변수의 key
curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/ci/variables/VARIABLE_1"

인스턴스 레벨 CI/CD 변수 API

Tier: Free, Premium, Ultimate
Offering: GitLab Self-Managed, GitLab Dedicated
원문 보기
요약

이 API를 사용하여 인스턴스의 CI/CD 변수와 상호 작용합니다. 모든 인스턴스 레벨 변수를 나열합니다. 특정 인스턴스 레벨 변수의 세부 정보를 가져옵니다. 최대 인스턴스 레벨 변수 수를 변경할 수 있습니다. 인스턴스 레벨 변수를 업데이트합니다.

이 API를 사용하여 인스턴스의 CI/CD 변수와 상호 작용합니다.

모든 인스턴스 변수 나열#

히스토리
  • GitLab 16.8에서 description 파라미터 도입됨.

모든 인스턴스 레벨 변수를 나열합니다. pageper_page 페이지화 파라미터를 사용하여 결과의 페이지화를 제어합니다.

GET /admin/ci/variables
curl \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/ci/variables"
[
    {
        "key": "TEST_VARIABLE_1",
        "description": null,
        "variable_type": "env_var",
        "value": "TEST_1",
        "protected": false,
        "masked": false,
        "raw": false
    },
    {
        "key": "TEST_VARIABLE_2",
        "description": null,
        "variable_type": "env_var",
        "value": "TEST_2",
        "protected": false,
        "masked": false,
        "raw": false
    }
]

인스턴스 변수 세부 정보 가져오기#

히스토리
  • GitLab 16.8에서 description 파라미터 도입됨.

특정 인스턴스 레벨 변수의 세부 정보를 가져옵니다.

GET /admin/ci/variables/:key
속성 유형 필수 여부 설명
key 문자열 Yes 변수의 key
curl \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/ci/variables/TEST_VARIABLE_1"
{
    "key": "TEST_VARIABLE_1",
    "description": null,
    "variable_type": "env_var",
    "value": "TEST_1",
    "protected": false,
    "masked": false,
    "raw": false
}

인스턴스 변수 만들기#

히스토리
  • GitLab 16.8에서 description 파라미터 도입됨.

새 인스턴스 레벨 변수를 만듭니다.

최대 인스턴스 레벨 변수 수를 변경할 수 있습니다.

POST /admin/ci/variables
속성 유형 필수 여부 설명
key 문자열 Yes 변수의 key. 최대 255자, A-Z, a-z, 0-9, _만 허용됩니다.
value 문자열 Yes 변수의 value. 최대 10,000자.
description 문자열 No 변수의 설명. 최대 255자.
masked 불리언 No 변수를 마스킹할지 여부.
protected 불리언 No 변수를 보호할지 여부.
raw 불리언 No 변수를 확장 가능하게 할지 여부.
variable_type 문자열 No 변수 유형. 사용 가능한 유형: env_var(기본값) 및 file.
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/ci/variables" \
  --form "key=NEW_VARIABLE" \
  --form "value=new value"
{
    "key": "NEW_VARIABLE",
    "description": null,
    "value": "new value",
    "variable_type": "env_var",
    "protected": false,
    "masked": false,
    "raw": false
}

인스턴스 변수 업데이트#

히스토리
  • GitLab 16.8에서 description 파라미터 도입됨.

인스턴스 레벨 변수를 업데이트합니다.

PUT /admin/ci/variables/:key
속성 유형 필수 여부 설명
description 문자열 No 변수의 설명. 최대 255자.
key 문자열 Yes 변수의 key. 최대 255자, A-Z, a-z, 0-9, _만 허용됩니다.
masked 불리언 No 변수를 마스킹할지 여부.
protected 불리언 No 변수를 보호할지 여부.
raw 불리언 No 변수를 확장 가능하게 할지 여부.
value 문자열 Yes 변수의 value. 최대 10,000자.
variable_type 문자열 No 변수 유형. 사용 가능한 유형: env_var(기본값) 및 file.
curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/ci/variables/NEW_VARIABLE" \
  --form "value=updated value"
{
    "key": "NEW_VARIABLE",
    "description": null,
    "value": "updated value",
    "variable_type": "env_var",
    "protected": true,
    "masked": true,
    "raw": true
}

인스턴스 변수 삭제#

인스턴스 레벨 변수를 삭제합니다.

DELETE /admin/ci/variables/:key
속성 유형 필수 여부 설명
key 문자열 Yes 변수의 key
curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/ci/variables/VARIABLE_1"