Download OpenAPI specification:Download
Testing Farm API
Test request details
| api_key required | string (api_key) An unique identifier used to authenticate a client. |
required | object (test) Details about the test to run. Only one test type can be specified. If the user needs to run multiple tests, it should do it in separate requests. |
Array of objects (environment_requested) [ items ] List of test environments to provision. | |
object (notification) Request update notification settings. | |
object (settings) Various request settings or tweaks. |
{- "api_key": "692f43c8636b1f1e2ab04c9881b4ab4e68088c9e",
- "test": {
- "fmf": {
- "ref": "0.10",
- "path": "/examples/wget",
- "name": "example-plan",
- "settings": {
- "recognize-errors": true
}
}, - "sti": {
- "ref": "f31",
- "playbooks": [
- "tests/tests*.yml"
], - "extra_variables": {
- "foo": "some-foo-value",
- "boo": "some-boo-value"
}
}
}, - "environments": [
- {
- "arch": "x86_64",
- "os": {
- "compose": "Fedora-Rawhide"
}, - "pool": "aws-pool-01",
- "variables": {
- "FOO": "some-value",
- "BOO": "other-value"
}, - "secrets": {
- "FOO": "some-value",
- "BOO": "other-value"
}, - "artifacts": [
- {
- "id": 43054146,
- "type": "fedora-koji-build",
- "packages": [
- "openssh"
]
}
], - "settings": {
- "pipeline": {
- "skip_guest_setup": true
}, - "provisioning": {
- "post_install_script": "#!/bin/sh\nsudo sed -i 's/.*ssh-rsa/ssh-rsa/' /root/.ssh/authorized_keys\n"
}
}, - "tmt": {
- "context": {
- "distro": "fedora-33",
- "arch": "x86_64",
- "trigger": "code"
}
}
}
], - "notification": {
- "webhook": {
- "url": "string",
- "token": "string"
}
}, - "settings": {
- "worker": {
- "image": "quay.io/testing-farm/worker:1.0"
}
}
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created": "2020-12-18T20:46:00.392227"
}| request_id required | string <uuid> (request_id) Provide request_id you are interested in. |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created": "2020-12-18T20:46:00.392227",
- "updated": "2020-12-18T20:46:00.392227",
- "environments": [
- {
- "arch": "x86_64",
- "os": {
- "compose": "Fedora-32-20200414.0"
}, - "pool": "aws",
- "variables": {
- "FOO": "some-value",
- "BOO": "other-value"
}
}
], - "state": "new",
- "notes": [
- {
- "level": "info",
- "message": "string"
}
], - "result": {
- "summary": "Installation of the artifact failed. See https://artifacts.testing-farm.io/4b1b77bd-8861-40d1-bda1-849728b49aaa/stages/artifact-installation/log.txt for more information.",
- "overall": "passed",
- "xunit": "https://artifacts.testing-farm.io/4b1b77bd-8861-40d1-bda1-849728b49aaa/xunit.xml\n"
}, - "run": {
- "stages": [
- {
- "name": "pre-artifact-installation",
- "notes": [
- {
- "level": "info",
- "message": "string"
}
], - "result": "passed",
}
],
}
}