--project <projectId> untuk menentukan proyek. Anda dapat menggunakan --branch <branchName> untuk beroperasi pada branch tertentu. Jika --branch dihilangkan, server menggunakan branch default.| Perintah | Deskripsi | Contoh |
|---|---|---|
login | Masuk dengan token akses dan menyimpannya secara lokal. | apidog login --with-token <token> |
logout | Keluar dan menghapus token lokal yang tersimpan. | apidog logout |
whoami | Menampilkan informasi tentang pengguna terautentikasi saat ini. | apidog whoami |
${{ vars.APIDOG_ACCESS_TOKEN }} untuk merujuknya.cli-schema untuk memeriksa dan memvalidasi file JSON sebelum membuat atau memperbarui sumber daya kompleks. Hal ini membantu mengurangi kegagalan permintaan yang disebabkan oleh data yang tidak valid.| Perintah | Deskripsi | Contoh |
|---|---|---|
cli-schema list | Mencantumkan semua kunci skema yang didukung oleh CLI. | apidog cli-schema list |
cli-schema get | Mencetak JSON Schema untuk file data perintah. | apidog cli-schema get endpoint-create |
cli-schema validate | Memvalidasi file JSON lokal terhadap kunci skema. | apidog cli-schema validate endpoint-create --file ./endpoint.json |
endpoint-create, test-scenario-update, dan merge-request-create.| Perintah | Deskripsi | Contoh |
|---|---|---|
team list | Mencantumkan tim yang dapat diakses oleh akun saat ini. | apidog team list |
team get | Melihat detail tim tertentu. | apidog team get <teamId> |
| Perintah | Deskripsi | Contoh |
|---|---|---|
project list | Mencantumkan proyek yang dapat diakses oleh akun saat ini. | apidog project list |
project get | Melihat detail proyek. | apidog project get <projectId> |
project create | Membuat proyek di bawah sebuah tim. | apidog project create --team <teamId> --name "New Project" |
| Perintah | Deskripsi | Contoh |
|---|---|---|
project settings get | Melihat pengaturan tingkat proyek. | apidog project settings get --project <projectId> |
project settings update | Memperbarui pengaturan proyek dengan file JSON. | apidog project settings update --project <projectId> --file ./project-settings.json |
cli-schema get project-settings-update | Melihat skema untuk pembaruan pengaturan proyek. | apidog cli-schema get project-settings-update |
| Perintah | Deskripsi | Contoh |
|---|---|---|
environment list | Mencantumkan lingkungan dalam sebuah proyek. | apidog environment list --project <projectId> |
environment get | Melihat detail lingkungan, seperti URL dasar. | apidog environment get <environmentId> --project <projectId> |
environment create | Membuat lingkungan. | apidog environment create <name> --project <projectId> --base-url <url> |
environment update | Memperbarui lingkungan. | apidog environment update <environmentId> --project <projectId> --file ./environment.json |
environment delete | Menghapus lingkungan. | apidog environment delete <environmentId> --project <projectId> |
cli-schema get environment-update | Melihat skema untuk pembaruan lingkungan. | apidog cli-schema get environment-update |
| Perintah | Deskripsi | Contoh |
|---|---|---|
variables list | Mencantumkan variabel berdasarkan cakupan. | apidog variables list --project <projectId> --scope global |
variables get | Melihat nilai suatu variabel. | apidog variables get --project <projectId> --scope global --key <key> |
variables set | Membuat atau memperbarui variabel. | apidog variables set --project <projectId> --scope global --key <key> --value <value> |
variables delete | Menghapus variabel. | apidog variables delete --project <projectId> --scope global --key <key> |
variables import | Mengimpor variabel dari file lokal. | apidog variables import --project <projectId> --scope global --file ./variables.json |
variables export | Mengekspor variabel ke file lokal. | apidog variables export --project <projectId> --scope global --output ./variables.json |
cli-schema get <schemaKey> dan cli-schema validate <schemaKey> --file <path> terlebih dahulu.| Perintah | Deskripsi | Contoh |
|---|---|---|
endpoint list | Mencantumkan endpoint HTTP API dalam sebuah proyek. | apidog endpoint list --project <projectId> |
endpoint get | Melihat detail endpoint. | apidog endpoint get <endpointId> --project <projectId> |
endpoint create | Membuat endpoint dari file JSON. | apidog endpoint create --project <projectId> --file ./endpoint.json |
endpoint update | Memperbarui endpoint. | apidog endpoint update <endpointId> --project <projectId> --file ./endpoint.json |
endpoint delete | Menghapus endpoint. | apidog endpoint delete <endpointId> --project <projectId> |
cli-schema get endpoint-create | Melihat skema untuk pembuatan endpoint. | apidog cli-schema get endpoint-create |
cli-schema get endpoint-update | Melihat skema untuk pembaruan endpoint. | apidog cli-schema get endpoint-update |
| Perintah | Deskripsi | Contoh |
|---|---|---|
schema list | Mencantumkan skema data dalam sebuah proyek. | apidog schema list --project <projectId> |
schema get | Melihat detail skema. | apidog schema get <schemaId> --project <projectId> |
schema create | Membuat skema data dari file JSON. | apidog schema create --project <projectId> --file ./schema.json |
schema update | Memperbarui skema data. | apidog schema update <schemaId> --project <projectId> --file ./schema.json |
schema delete | Menghapus skema data. | apidog schema delete <schemaId> --project <projectId> |
cli-schema get schema-create | Melihat skema untuk pembuatan skema data. | apidog cli-schema get schema-create |
cli-schema get schema-update | Melihat skema untuk pembaruan skema data. | apidog cli-schema get schema-update |
| Perintah | Deskripsi | Contoh |
|---|---|---|
doc list | Mencantumkan dokumen Markdown. | apidog doc list --project <projectId> |
doc get | Melihat detail dokumen Markdown. | apidog doc get <docId> --project <projectId> |
doc create | Membuat dokumen Markdown. | apidog doc create --project <projectId> --file ./doc.json |
doc update | Memperbarui dokumen Markdown. | apidog doc update <docId> --project <projectId> --file ./doc.json |
doc delete | Menghapus dokumen Markdown. | apidog doc delete <docId> --project <projectId> |
folder untuk mengelola pohon folder bagi berbagai jenis sumber daya. Opsi --type memilih jenis sumber daya, seperti endpoint, schema, test-scenario, response-component, security-scheme, test-suite, atau test-data.| Perintah | Deskripsi | Contoh |
|---|---|---|
folder list | Mencantumkan folder berdasarkan jenis sumber daya. | apidog folder list --project <projectId> --type endpoint |
folder create | Membuat folder berdasarkan jenis sumber daya. | apidog folder create --project <projectId> --type endpoint --name "New Folder" |
folder move | Memindahkan folder ke folder induk lain. | apidog folder move <folderId> --project <projectId> --type endpoint --parent <parentId> |
folder update | Memperbarui nama, deskripsi, atau induk folder. | apidog folder update <folderId> --project <projectId> --type endpoint --name "New Folder Name" |
folder delete | Menghapus folder. | apidog folder delete <folderId> --project <projectId> --type endpoint |
cli-schema get folder-create | Melihat skema untuk pembuatan folder. | apidog cli-schema get folder-create |
cli-schema get folder-update | Melihat skema untuk pembaruan folder. | apidog cli-schema get folder-update |
--type memilih jenis folder sumber daya. Opsi tersebut bukan nama folder. Kolom description hanya didukung untuk folder endpoint dan test-scenario; jenis folder lainnya hanya mendukung pembaruan nama dan induk.| Perintah | Deskripsi | Contoh |
|---|---|---|
mock list | Mencantumkan aturan mock dalam proyek atau di bawah endpoint. | apidog mock list --project <projectId> --http-api-id <endpointId> |
mock get | Melihat aturan mock. | apidog mock get <mockId> --project <projectId> |
mock create | Membuat aturan mock dari file JSON. | apidog mock create --project <projectId> --file ./mock.json |
mock update | Memperbarui aturan mock. | apidog mock update <mockId> --project <projectId> --file ./mock.json |
mock delete | Menghapus aturan mock. | apidog mock delete <mockId> --project <projectId> |
cli-schema get mock-create | Melihat skema untuk pembuatan aturan mock. | apidog cli-schema get mock-create |
cli-schema get mock-update | Melihat skema untuk pembaruan aturan mock. | apidog cli-schema get mock-update |
| Perintah | Deskripsi | Contoh |
|---|---|---|
common-parameter list | Mencantumkan parameter umum yang dapat digunakan kembali. | apidog common-parameter list --project <projectId> |
common-parameter get | Melihat detail parameter umum. | apidog common-parameter get <commonParameterId> --project <projectId> |
common-parameter create | Membuat parameter umum dari file JSON. | apidog common-parameter create --project <projectId> --file ./common-parameter.json |
common-parameter update | Memperbarui parameter umum. | apidog common-parameter update <commonParameterId> --project <projectId> --file ./common-parameter.json |
common-parameter import | Mengimpor parameter umum dari file. | apidog common-parameter import --project <projectId> --file ./common-parameters.json |
common-parameter export | Mengekspor parameter umum ke file lokal. | apidog common-parameter export --project <projectId> --output ./common-parameters.json |
| Perintah | Deskripsi | Contoh |
|---|---|---|
response-component list | Mencantumkan komponen respons yang dapat digunakan kembali. | apidog response-component list --project <projectId> |
response-component get | Melihat detail komponen respons. | apidog response-component get <responseComponentId> --project <projectId> |
response-component create | Membuat komponen respons dari file JSON. | apidog response-component create --project <projectId> --file ./response-component.json |
response-component update | Memperbarui komponen respons. | apidog response-component update <responseComponentId> --project <projectId> --file ./response-component.json |
response-component delete | Menghapus komponen respons. | apidog response-component delete <responseComponentId> --project <projectId> |
| Perintah | Deskripsi | Contoh |
|---|---|---|
security-scheme list | Mencantumkan skema keamanan dalam sebuah proyek. | apidog security-scheme list --project <projectId> |
security-scheme get | Melihat detail skema keamanan. | apidog security-scheme get <schemeId> --project <projectId> |
security-scheme create | Membuat skema keamanan dari file JSON. | apidog security-scheme create --project <projectId> --file ./scheme.json |
security-scheme update | Memperbarui skema keamanan. | apidog security-scheme update <schemeId> --project <projectId> --file ./scheme.json |
security-scheme delete | Menghapus skema keamanan. | apidog security-scheme delete <schemeId> --project <projectId> |
/, bungkus path dengan tanda kutip, misalnya --path '/api/users', atau gunakan --file untuk menyediakan data endpoint.responseId harus menggunakan ID definisi respons endpoint dari endpoint.responses[].id, bukan ID komponen respons. Untuk menggunakan kembali komponen respons, tautkan terlebih dahulu dalam definisi respons endpoint.| Perintah | Deskripsi | Contoh |
|---|---|---|
test-case list | Mencantumkan kasus pengujian API, secara opsional difilter berdasarkan endpoint. | apidog test-case list --project <projectId> --endpoint <endpointId> |
test-case category | Mencantumkan kategori kasus pengujian. | apidog test-case category --project <projectId> |
test-case get | Melihat detail kasus pengujian API. | apidog test-case get <caseId> --project <projectId> |
test-case create | Membuat kasus pengujian API dari file JSON. | apidog test-case create --project <projectId> --file ./case.json |
test-case update | Memperbarui kasus pengujian API. | apidog test-case update <caseId> --project <projectId> --file ./case.json |
test-case delete | Menghapus kasus pengujian API. | apidog test-case delete <caseId> --project <projectId> |
cli-schema get test-case-create | Melihat skema untuk pembuatan kasus pengujian. | apidog cli-schema get test-case-create |
cli-schema get test-case-update | Melihat skema untuk pembaruan kasus pengujian. | apidog cli-schema get test-case-update |
| Perintah | Deskripsi | Contoh |
|---|---|---|
test-scenario list | Mencantumkan skenario pengujian dalam sebuah proyek. | apidog test-scenario list --project <projectId> |
test-scenario get | Melihat detail skenario pengujian. | apidog test-scenario get <scenarioId> --project <projectId> |
test-scenario create | Membuat skenario pengujian. | apidog test-scenario create --project <projectId> --file ./scenario.json |
test-scenario update | Memperbarui skenario pengujian. | apidog test-scenario update <scenarioId> --project <projectId> --file ./scenario.json |
test-scenario delete | Menghapus skenario pengujian. | apidog test-scenario delete <scenarioId> --project <projectId> |
test-scenario run | Menjalankan skenario pengujian. | apidog test-scenario run <scenarioId> --project <projectId> --environment <environmentId> |
cli-schema get test-scenario-create | Melihat skema untuk pembuatan skenario pengujian. | apidog cli-schema get test-scenario-create |
cli-schema get test-scenario-update | Melihat skema untuk pembaruan skenario pengujian. | apidog cli-schema get test-scenario-update |
| Perintah | Deskripsi | Contoh |
|---|---|---|
test-suite list | Mencantumkan rangkaian pengujian dalam sebuah proyek. | apidog test-suite list --project <projectId> |
test-suite get | Melihat detail rangkaian pengujian. | apidog test-suite get <testSuiteId> --project <projectId> |
test-suite create | Membuat rangkaian pengujian. | apidog test-suite create --project <projectId> --file ./suite.json |
test-suite update | Memperbarui rangkaian pengujian. | apidog test-suite update <testSuiteId> --project <projectId> --file ./suite.json |
test-suite delete | Menghapus rangkaian pengujian. | apidog test-suite delete <testSuiteId> --project <projectId> |
test-suite run | Menjalankan rangkaian pengujian. | apidog test-suite run <testSuiteId> --project <projectId> --environment <environmentId> |
| Perintah | Deskripsi | Contoh |
|---|---|---|
test-data list | Mencantumkan set data pengujian. | apidog test-data list --project <projectId> |
test-data get | Melihat detail set data pengujian. | apidog test-data get <dataId> --project <projectId> |
test-data create | Membuat set data pengujian dari file JSON. | apidog test-data create --project <projectId> --file ./test-data.json |
test-data update | Memperbarui set data pengujian. | apidog test-data update <dataId> --project <projectId> --file ./test-data.json |
test-data delete | Menghapus set data pengujian. | apidog test-data delete <dataId> --project <projectId> |
| Perintah | Deskripsi | Contoh |
|---|---|---|
test-report list | Mencantumkan laporan pengujian dalam sebuah proyek. | apidog test-report list --project <projectId> |
test-report get | Melihat detail laporan pengujian. | apidog test-report get <reportId> --project <projectId> |
test-report download | Mengunduh laporan pengujian ke file lokal. | apidog test-report download <reportId> --project <projectId> --format json --output ./report.json |
test-report delete | Menghapus laporan pengujian. | apidog test-report delete <reportId> --project <projectId> |
| Perintah | Deskripsi | Contoh |
|---|---|---|
runner list | Mencantumkan runner dalam proyek atau tim. | apidog runner list --project <projectId> |
runner get | Melihat detail runner. | apidog runner get <runnerId> --project <projectId> |
runner create | Membuat runner tim. | apidog runner create --team <teamId> --name <name> --runner-type <runnerType> --server-type <serverType> |
runner check | Memeriksa kesehatan runner. | apidog runner check <runnerId> --team <teamId> |
runner delete | Menghapus runner. | apidog runner delete <runnerId> --project <projectId> |
| Perintah | Deskripsi | Contoh |
|---|---|---|
scheduled-task list | Mencantumkan tugas terjadwal dalam sebuah proyek. | apidog scheduled-task list --project <projectId> |
scheduled-task get | Melihat detail tugas terjadwal. | apidog scheduled-task get <taskId> --project <projectId> |
scheduled-task create | Membuat tugas terjadwal dari file JSON. | apidog scheduled-task create --project <projectId> --file ./scheduled-task.json |
scheduled-task update | Memperbarui tugas terjadwal. | apidog scheduled-task update <taskId> --project <projectId> --file ./scheduled-task.json |
scheduled-task delete | Menghapus tugas terjadwal. | apidog scheduled-task delete <taskId> --project <projectId> |
scheduled-task run | Memicu tugas terjadwal secara manual. | apidog scheduled-task run <taskId> --project <projectId> |
apidog run| Opsi | Deskripsi |
|---|---|
--access-token <accessToken> | Menetapkan token autentikasi untuk eksekusi online |
-t, --test-scenario <testScenarioId> | Menentukan ID skenario pengujian yang akan dijalankan |
-f, --test-scenario-folder <folderId> | Menentukan ID direktori skenario pengujian yang akan dijalankan |
--test-suite <testSuiteId> | Menentukan ID rangkaian pengujian yang akan dijalankan |
--project <projectId> | Menentukan ID proyek |
--branch <branchName> | Menentukan nama branch; jika dihilangkan, server secara default menggunakan branch utama |
-r, --reporters [reporters] | Menentukan jenis laporan pengujian (default: ["cli"]) |
--out-dir <outDir> | Direktori output untuk laporan pengujian (default: ./apidog-reports) |
--out-file <outFile> | Nama file laporan pengujian tanpa perlu menambahkan ekstensi file. Anda dapat menggunakan {FOLDER_NAME}, {SCENARIO_NAME}, dan {GENERATE_TIME} |
--out-json-failures-separated <outJsonFailuresSeparated> | Mengekspor kegagalan sebagai file JSON terpisah |
-e, --environment <environmentId> | Menentukan lingkungan runtime |
-n, --iteration-count <n> | Menetapkan jumlah iterasi |
-d, --iteration-data <path> | Menetapkan data untuk iterasi kasus (JSON atau CSV) |
--on-error <behavior> | Menetapkan perilaku penanganan kesalahan (ignore, continue, atau end) |
--variables <path> | Memuat variabel lingkungan atau global dari file lokal |
--global-var <value> | Menetapkan variabel global (format key=value) |
--env-var <value> | Menetapkan variabel lingkungan (format key=value) |
--notification <ids> | Mengirim notifikasi setelah proses run selesai |
--notification-failed-event <ids> | Mengirim notifikasi hanya saat proses run gagal |
--external-program-path <path> | Menentukan path file untuk program eksternal |
--database-connection <path> | Menentukan path file untuk konfigurasi basis data |
--ignore-redirects | Mencegah pengalihan otomatis |
--silent | Mencegah output konsol |
--color <value> | Mengaktifkan atau menonaktifkan output konsol berwarna |
--delay-request [n] | Menentukan jeda antar permintaan (ms) |
--timeout-request [n] | Menentukan timeout permintaan (ms) |
--timeout-script [n] | Menentukan timeout eksekusi skrip (ms) |
-k, --insecure | Menonaktifkan verifikasi SSL |
--ssl-client-cert-list <path> | Menentukan path konfigurasi sertifikat klien |
--ssl-client-cert <path> | Menentukan path sertifikat klien (PEM) |
--ssl-client-key <path> | Menentukan path kunci privat sertifikat klien |
--ssl-client-passphrase <passphrase> | Menentukan passphrase sertifikat klien |
--ssl-extra-ca-certs <path> | Menentukan sertifikat CA tepercaya tambahan |
-b, --bigint | Mengaktifkan kompatibilitas bigint |
--upload-report [value] | Mengunggah ringkasan laporan pengujian ke cloud |
--preferred-http-version <preferredHttpVersion> | Menetapkan versi protokol HTTP yang dipilih |
--verbose | Menampilkan informasi permintaan dan respons secara detail |
--lang <language> | Menetapkan bahasa CLI (en) |
-h, --help | Menampilkan informasi bantuan |
cli-schema get <schemaKey> terlebih dahulu, lalu validasi file lokal Anda dengan cli-schema validate <schemaKey> --file <path>.import mengimpor file lokal ke dalam proyek. Format yang didukung mencakup openapi, postman, har, insomnia, jmeter, wsdl, yapi, rap2, apidoc, hoppscotch, markdown, jsonschema, dan apidog.| Perintah | Deskripsi | Contoh |
|---|---|---|
import | Mengimpor file lokal ke dalam proyek berdasarkan format. | apidog import --project <projectId> --format openapi --file ./openapi.json |
import auto-import untuk memelihara pengaturan impor otomatis untuk sinkronisasi jangka panjang dari sumber eksternal.| Perintah | Deskripsi | Contoh |
|---|---|---|
import auto-import list | Mencantumkan pengaturan impor otomatis dalam sebuah proyek. | apidog import auto-import list --project <projectId> |
import auto-import create | Membuat pengaturan impor otomatis. | apidog import auto-import create --project <projectId> --file ./auto-import.json |
import auto-import get | Melihat pengaturan impor otomatis. | apidog import auto-import get <settingId> --project <projectId> |
import auto-import delete | Menghapus pengaturan impor otomatis. | apidog import auto-import delete <settingId> --project <projectId> |
cli-schema get import-auto-import-create | Melihat skema untuk pengaturan impor otomatis. | apidog cli-schema get import-auto-import-create |
export mengekspor data proyek ke file lokal. Format yang didukung mencakup openapi, markdown, html, postman, dan apidog.apidog, cakupan mendukung all, apis, dan tags. Cakupan folder hanya tersedia untuk ekspor OpenAPI.| Perintah | Deskripsi | Contoh |
|---|---|---|
export | Mengekspor data proyek berdasarkan format. | apidog export --project <projectId> --format openapi --output ./openapi.json |
export --format apidog | Mengekspor data proyek native. | apidog export --project <projectId> --format apidog --output ./project.apidog.json |
export --scope apis | Mengekspor API terpilih dalam format native. | apidog export --project <projectId> --format apidog --scope apis --api-ids 1001,1002 --output ./selected.apidog.json |
export --scope tags | Mengekspor API berdasarkan tag dalam format native. | apidog export --project <projectId> --format apidog --scope tags --include-tags pet,store --output ./tagged.apidog.json |
export --format openapi --scope folders | Mengekspor folder terpilih dalam format OpenAPI. | apidog export --project <projectId> --format openapi --scope folders --folder-ids 2001 --output ./openapi.json |
export settings untuk memelihara pengaturan ekspor OAS yang dapat digunakan kembali.| Perintah | Deskripsi | Contoh |
|---|---|---|
export settings list | Mencantumkan pengaturan ekspor OAS. | apidog export settings list --project <projectId> |
export settings create | Membuat pengaturan ekspor OAS. | apidog export settings create --project <projectId> --file ./export-setting.json |
export settings get | Melihat pengaturan ekspor OAS. | apidog export settings get <settingId> --project <projectId> |
export settings update | Memperbarui pengaturan ekspor OAS. | apidog export settings update <settingId> --project <projectId> --file ./export-setting.json |
export settings delete | Menghapus pengaturan ekspor OAS. | apidog export settings delete <settingId> --project <projectId> |
cli-schema get export-settings-create | Melihat skema untuk pembuatan pengaturan ekspor OAS. | apidog cli-schema get export-settings-create |
cli-schema get export-settings-update | Melihat skema untuk pembaruan pengaturan ekspor OAS. | apidog cli-schema get export-settings-update |
| Perintah | Deskripsi | Contoh |
|---|---|---|
docs-site list | Mencantumkan situs dokumentasi. | apidog docs-site list --project <projectId> |
docs-site get | Melihat detail situs dokumentasi. | apidog docs-site get <siteId> --project <projectId> |
docs-site create | Membuat situs dokumentasi. | apidog docs-site create --project <projectId> --file ./docs-site.json |
docs-site update | Memperbarui pengaturan situs dokumentasi. | apidog docs-site update <siteId> --project <projectId> --file ./docs-site.json |
docs-site delete | Menghapus situs dokumentasi. | apidog docs-site delete <siteId> --project <projectId> |
| Perintah | Deskripsi | Contoh |
|---|---|---|
shared-doc list | Mencantumkan dokumen bersama. | apidog shared-doc list --project <projectId> |
shared-doc get | Melihat detail dokumen bersama. | apidog shared-doc get <docId> --project <projectId> |
shared-doc create | Membuat dokumen bersama. | apidog shared-doc create --project <projectId> --file ./shared-doc.json |
shared-doc update | Memperbarui pengaturan dokumen bersama. | apidog shared-doc update <docId> --project <projectId> --file ./shared-doc.json |
shared-doc delete | Menghapus dokumen bersama. | apidog shared-doc delete <docId> --project <projectId> |
| Perintah | Deskripsi | Contoh |
|---|---|---|
branch list --type all | Mencantumkan semua jenis branch dalam sebuah proyek. | apidog branch list --project <projectId> --type all |
branch list --type sprint | Mencantumkan branch iterasi. | apidog branch list --project <projectId> --type sprint |
branch get --type sprint | Melihat branch iterasi. | apidog branch get <branchName> --project <projectId> --type sprint |
branch create --type sprint | Membuat branch iterasi. | apidog branch create --project <projectId> --type sprint --name <branchName> --from main |
branch update --type sprint | Memperbarui branch iterasi. | apidog branch update <branchName> --project <projectId> --type sprint --name <newName> |
branch merge | Menggabungkan sumber daya yang dipilih secara eksplisit dari satu branch ke branch lain. | apidog branch merge --project <projectId> --from <sourceBranchName> --to <targetBranchName> --endpoint-ids <ids> |
branch pick-to | Memilih sumber daya terpilih dari branch sumber ke branch target. | apidog branch pick-to --project <projectId> --from <sourceBranchName> --to <targetBranchName> --endpoint-ids <ids> |
branch archive --type sprint | Mengarsipkan branch iterasi sebelum penghapusan. | apidog branch archive <branchName> --project <projectId> --type sprint |
branch delete --type sprint | Menghapus branch iterasi yang telah diarsipkan. | apidog branch delete <branchName> --project <projectId> --type sprint |
| Perintah | Deskripsi | Contoh |
|---|---|---|
branch list --type ai | Mencantumkan branch AI. | apidog branch list --project <projectId> --type ai |
branch get --type ai | Melihat branch AI. | apidog branch get <branchName> --project <projectId> --type ai |
branch create --type ai | Membuat branch AI dari branch sumber. | apidog branch create --project <projectId> --type ai --name <aiBranchName> --from <sourceBranchName> |
branch update --type ai | Memperbarui branch AI. | apidog branch update <branchName> --project <projectId> --type ai --name <newName> |
branch archive --type ai | Mengarsipkan branch AI sebelum penghapusan. | apidog branch archive <branchName> --project <projectId> --type ai |
branch delete --type ai | Menghapus branch AI yang telah diarsipkan. | apidog branch delete <branchName> --project <projectId> --type ai |
| Perintah | Deskripsi | Contoh |
|---|---|---|
branch list --type general | Mencantumkan branch umum. | apidog branch list --project <projectId> --type general |
branch get --type general | Melihat branch umum. | apidog branch get <branchName> --project <projectId> --type general |
branch create --type general | Membuat branch umum. | apidog branch create --project <projectId> --type general --name <branchName> --from main |
branch update --type general | Memperbarui branch umum. | apidog branch update <branchName> --project <projectId> --type general --name <newName> |
branch delete --type general | Menghapus branch umum. | apidog branch delete <branchName> --project <projectId> --type general |
--type, --name, dan --from. cli-schema get branch-*-create digunakan untuk memeriksa struktur opsi pembuatan. Untuk opsi perintah yang sebenarnya, jalankan apidog branch create -h.merge-request saat branch target memerlukan alur peninjauan. Merge request dan penggabungan langsung hanya menggabungkan sumber daya yang dipilih secara eksplisit.| Perintah | Deskripsi | Contoh |
|---|---|---|
merge-request preview | Memindai perubahan kandidat sebelum membuat merge request atau penggabungan langsung. | apidog merge-request preview --project <projectId> --from <sourceBranchName> --to <targetBranchName> |
merge-request list | Mencantumkan merge request. | apidog merge-request list --project <projectId> --to <targetBranchName> |
merge-request get | Melihat detail merge request. | apidog merge-request get <mergeRequestId> --project <projectId> --to <targetBranchName> |
merge-request create | Membuat merge request. | apidog merge-request create --project <projectId> --to <targetBranchName> --from <sourceBranchName> --reviewer-ids <userIds> --endpoint-ids <ids> |
merge-request update | Memperbarui merge request. | apidog merge-request update <mergeRequestId> --project <projectId> --to <targetBranchName> --file ./merge-request.json |
merge-request approve | Menyetujui merge request. | apidog merge-request approve <mergeRequestId> --project <projectId> --to <targetBranchName> --file ./approve.json |
merge-request reject | Menolak merge request. | apidog merge-request reject <mergeRequestId> --project <projectId> --to <targetBranchName> |
merge-request delete | Menghapus merge request. | apidog merge-request delete <mergeRequestId> --project <projectId> --to <targetBranchName> |
merge atau merge-request.ai/20260312-from-main-user-register.--endpoint-ids 1,2, --doc-ids 3,4, dan --test-suite-ids 5,6.| Perintah | Deskripsi | Contoh |
|---|---|---|
custom-field list | Mencantumkan kolom kustom. | apidog custom-field list --project <projectId> |
custom-field create | Membuat kolom kustom. | apidog custom-field create --project <projectId> --file ./custom-field.json |
custom-field update | Memperbarui kolom kustom. | apidog custom-field update <customFieldId> --project <projectId> --file ./custom-field.json |
custom-field delete | Menghapus kolom kustom. | apidog custom-field delete <customFieldId> --project <projectId> |
| Perintah | Deskripsi | Contoh |
|---|---|---|
websocket list | Mencantumkan API WebSocket. | apidog websocket list --project <projectId> |
websocket get | Melihat detail API WebSocket. | apidog websocket get <websocketId> --project <projectId> |
websocket create | Membuat API WebSocket. | apidog websocket create --project <projectId> --name <name> --url <url> |
websocket update | Memperbarui API WebSocket. | apidog websocket update <websocketId> --project <projectId> --file ./websocket.json |
websocket delete | Menghapus API WebSocket. | apidog websocket delete <websocketId> --project <projectId> |
| Perintah | Deskripsi | Contoh |
|---|---|---|
socketio list | Mencantumkan API Socket.IO. | apidog socketio list --project <projectId> |
socketio get | Melihat detail API Socket.IO. | apidog socketio get <socketioId> --project <projectId> |
socketio create | Membuat API Socket.IO. | apidog socketio create --project <projectId> --file ./socketio.json |
socketio update | Memperbarui API Socket.IO. | apidog socketio update <socketioId> --project <projectId> --file ./socketio.json |
socketio delete | Menghapus API Socket.IO. | apidog socketio delete <socketioId> --project <projectId> |
| Perintah | Deskripsi | Contoh |
|---|---|---|
common-script list | Mencantumkan skrip umum. | apidog common-script list --project <projectId> |
common-script get | Melihat detail skrip umum. | apidog common-script get <scriptId> --project <projectId> |
common-script create | Membuat skrip umum. | apidog common-script create --project <projectId> --file ./common-script.json |
common-script update | Memperbarui skrip umum. | apidog common-script update <scriptId> --project <projectId> --file ./common-script.json |
common-script delete | Menghapus skrip umum. | apidog common-script delete <scriptId> --project <projectId> |
| Perintah | Deskripsi | Contoh |
|---|---|---|
database-connection list | Mencantumkan koneksi basis data. | apidog database-connection list --project <projectId> |
database-connection get | Melihat detail koneksi basis data. | apidog database-connection get <connectionId> --project <projectId> |
database-connection create | Membuat koneksi basis data. | apidog database-connection create --project <projectId> --file ./database-connection.json |
database-connection update | Memperbarui koneksi basis data. | apidog database-connection update <connectionId> --project <projectId> --file ./database-connection.json |
database-connection delete | Menghapus koneksi basis data. | apidog database-connection delete <connectionId> --project <projectId> |
| Perintah | Deskripsi | Contoh |
|---|---|---|
vault list | Mencantumkan penyedia vault. | apidog vault list --project <projectId> |
vault get | Melihat detail penyedia vault. | apidog vault get <vaultProviderId> --project <projectId> |
vault create | Membuat penyedia vault. | apidog vault create --project <projectId> --file ./vault.json |
vault update | Memperbarui penyedia vault. | apidog vault update <vaultProviderId> --project <projectId> --file ./vault.json |
vault delete | Menghapus penyedia vault. | apidog vault delete <vaultProviderId> --project <projectId> |
| Perintah | Deskripsi | Contoh |
|---|---|---|
git-connection list | Mencantumkan koneksi Git. | apidog git-connection list --project <projectId> |
git-connection get | Melihat detail koneksi Git. | apidog git-connection get <connectionId> --project <projectId> |
git-connection create | Membuat koneksi Git. | apidog git-connection create --project <projectId> --file ./git-connection.json |
git-connection update | Memperbarui koneksi Git. | apidog git-connection update <connectionId> --project <projectId> --file ./git-connection.json |
git-connection delete | Menghapus koneksi Git. | apidog git-connection delete <connectionId> --project <projectId> |
| Perintah | Deskripsi | Contoh |
|---|---|---|
notification list | Mencantumkan konfigurasi notifikasi. | apidog notification list --project <projectId> |
notification get | Melihat detail notifikasi. | apidog notification get <notificationId> --project <projectId> |
notification create | Membuat konfigurasi notifikasi. | apidog notification create --project <projectId> --file ./notification.json |
notification update | Memperbarui konfigurasi notifikasi. | apidog notification update <notificationId> --project <projectId> --file ./notification.json |
notification delete | Menghapus konfigurasi notifikasi. | apidog notification delete <notificationId> --project <projectId> |
| Perintah | Deskripsi | Contoh |
|---|---|---|
recycle list | Mencantumkan sumber daya dalam recycle bin. | apidog recycle list --project <projectId> |
recycle restore | Memulihkan sumber daya dari recycle bin. | apidog recycle restore <itemId> --project <projectId> |
recycle delete | Menghapus sumber daya recycle bin secara permanen. | apidog recycle delete <itemId> --project <projectId> |
| Perintah | Deskripsi | Contoh |
|---|---|---|
history list | Mencantumkan riwayat perubahan proyek. | apidog history list --project <projectId> |
history get | Melihat detail riwayat perubahan. | apidog history get <historyId> --project <projectId> |
| Perintah | Deskripsi | Contoh |
|---|---|---|
audit-log list | Mencantumkan log audit proyek. | apidog audit-log list --project <projectId> |
audit-log get | Melihat detail log audit. | apidog audit-log get <auditLogId> --project <projectId> |
png di bawah folder data dalam repo GitHub, Anda dapat menggunakan data/to-be-uploaded.png untuk merujuknya.--database-connection. Anda dapat menggunakan baris perintah ini apa adanya untuk menjalankan pengujian Anda.--upload-report di akhir perintah CLI Anda. Berikut cara melakukannya:--upload-report ke perintah CLI Anda:./scripts. Jika tidak ada hierarki yang ditentukan, default-nya adalah direktori eksekusi CLI saat ini.--ssl-client-cert--ssl-client-key--ssl-client-passphrase--ssl-client-cert-listssl-client-cert-list.json[
{
"name": "domain1",
"matches": ["https://test.domain1.com/*", "https://www.domain1/*"],
"key": {"src": "/CI/client.domain1.key"},
"cert": {"src": "/CI/client.domain1.crt"},
"passphrase": "changeme"
},
{
"name": "domain2",
"matches": ["https://domain2.com/*"],
"key": {"src": "/CI/client.domain2.key"},
"cert": {"src": "/CI/client.domain2.crt"},
"passphrase": "changeme"
}
]--ssl-client-cert, --ssl-client-key, dan --ssl-client-passphrase. Opsi-opsi tersebut akan digunakan sebagai opsi fallback jika tidak ada kecocokan untuk URL dalam daftar.--preferred-http-version."HTTP/2" - HTTP/2 Application-Layer Protocol Negotiation (ALPN), hanya didukung untuk permintaan HTTPS."HTTP/2-with-prior-knowledge" - HTTP/2 dengan prior knowledge."HTTP/1" - HTTP/1.1.