| applicationId required | https://api.qovery.com/application/{applicationId}/advancedSettings Request samples Content typeapplication/json {"deployment.custom_domain_check_enabled": true, "deployment.termination_grace_period_seconds": 60, "deployment.affinity.node.required": {"property1": "string", "property2": "string"
}, "deployment.antiaffinity.pod": "Preferred", "deployment.update_strategy.type": "RollingUpdate", "deployment.update_strategy.rolling_update.max_unavailable_percent": 25, "deployment.update_strategy.rolling_update.max_surge_percent": 25, "build.timeout_max_sec": 1800, "build.cpu_max_in_milli": 4000, "build.ram_max_in_gib": 8, "network.ingress.proxy_body_size_mb": 100, "network.ingress.enable_cors": false, "network.ingress.cors_allow_origin": "*", "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS", "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization", "network.ingress.proxy_buffer_size_kb": 4, "network.ingress.keepalive_time_seconds": 3600, "network.ingress.keepalive_timeout_seconds": 60, "network.ingress.send_timeout_seconds": 60, "network.ingress.proxy_connect_timeout_seconds": 60, "network.ingress.proxy_send_timeout_seconds": 60, "network.ingress.proxy_read_timeout_seconds": 60, "network.ingress.proxy_buffering": "on", "network.ingress.proxy_request_buffering": "on", "network.ingress.whitelist_source_range": "0.0.0.0/0", "network.ingress.denylist_source_range": "", "network.ingress.basic_auth_env_var": "", "network.ingress.enable_sticky_session": false, "network.ingress.grpc_send_timeout_seconds": 60, "network.ingress.grpc_read_timeout_seconds": 60, "network.ingress.extra_headers": "{\"X-Frame-Options\":\"DENY \",\"X-Content-Type-Options\":\"nosniff\"}", "hpa.cpu.average_utilization_percent": 60, "security.service_account_name": ""
} Response samples Content typeapplication/json {"deployment.custom_domain_check_enabled": true, "deployment.termination_grace_period_seconds": 60, "deployment.affinity.node.required": {"property1": "string", "property2": "string"
}, "deployment.antiaffinity.pod": "Preferred", "deployment.update_strategy.type": "RollingUpdate", "deployment.update_strategy.rolling_update.max_unavailable_percent": 25, "deployment.update_strategy.rolling_update.max_surge_percent": 25, "build.timeout_max_sec": 1800, "build.cpu_max_in_milli": 4000, "build.ram_max_in_gib": 8, "network.ingress.proxy_body_size_mb": 100, "network.ingress.enable_cors": false, "network.ingress.cors_allow_origin": "*", "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS", "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization", "network.ingress.proxy_buffer_size_kb": 4, "network.ingress.keepalive_time_seconds": 3600, "network.ingress.keepalive_timeout_seconds": 60, "network.ingress.send_timeout_seconds": 60, "network.ingress.proxy_connect_timeout_seconds": 60, "network.ingress.proxy_send_timeout_seconds": 60, "network.ingress.proxy_read_timeout_seconds": 60, "network.ingress.proxy_buffering": "on", "network.ingress.proxy_request_buffering": "on", "network.ingress.whitelist_source_range": "0.0.0.0/0", "network.ingress.denylist_source_range": "", "network.ingress.basic_auth_env_var": "", "network.ingress.enable_sticky_session": false, "network.ingress.grpc_send_timeout_seconds": 60, "network.ingress.grpc_read_timeout_seconds": 60, "network.ingress.extra_headers": "{\"X-Frame-Options\":\"DENY \",\"X-Content-Type-Options\":\"nosniff\"}", "hpa.cpu.average_utilization_percent": 60, "security.service_account_name": ""
}List application custom domains Responseshttps://api.qovery.com/container/{containerId}/advancedSettings Response samples Content typeapplication/json {"deployment.custom_domain_check_enabled": true, "deployment.termination_grace_period_seconds": 60, "deployment.affinity.node.required": {"property1": "string", "property2": "string"
}, "deployment.antiaffinity.pod": "Preferred", "deployment.update_strategy.type": "RollingUpdate", "deployment.update_strategy.rolling_update.max_unavailable_percent": 25, "deployment.update_strategy.rolling_update.max_surge_percent": 25, "network.ingress.proxy_body_size_mb": 100, "network.ingress.enable_cors": false, "network.ingress.cors_allow_origin": "*", "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS", "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization", "network.ingress.proxy_buffer_size_kb": 4, "network.ingress.keepalive_time_seconds": 3600, "network.ingress.keepalive_timeout_seconds": 60, "network.ingress.send_timeout_seconds": 60, "network.ingress.proxy_connect_timeout_seconds": 60, "network.ingress.proxy_send_timeout_seconds": 60, "network.ingress.proxy_read_timeout_seconds": 60, "network.ingress.grpc_send_timeout_seconds": 60, "network.ingress.grpc_read_timeout_seconds": 60, "network.ingress.whitelist_source_range": "0.0.0.0/0", "network.ingress.denylist_source_range": "", "network.ingress.basic_auth_env_var": "", "network.ingress.enable_sticky_session": false, "security.service_account_name": "", "hpa.cpu.average_utilization_percent": 60
}Edit advanced settings Edit advanced settings by returning table of advanced settings.
+ https://api.qovery.com/container/{containerId}/advancedSettings Response samples Content typeapplication/json {"deployment.custom_domain_check_enabled": true, "deployment.termination_grace_period_seconds": 60, "deployment.affinity.node.required": {"property1": "string", "property2": "string"
}, "deployment.antiaffinity.pod": "Preferred", "deployment.update_strategy.type": "RollingUpdate", "deployment.update_strategy.rolling_update.max_unavailable_percent": 25, "deployment.update_strategy.rolling_update.max_surge_percent": 25, "network.ingress.proxy_body_size_mb": 100, "network.ingress.enable_cors": false, "network.ingress.cors_allow_origin": "*", "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS", "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization", "network.ingress.proxy_buffer_size_kb": 4, "network.ingress.keepalive_time_seconds": 3600, "network.ingress.keepalive_timeout_seconds": 60, "network.ingress.send_timeout_seconds": 60, "network.ingress.proxy_connect_timeout_seconds": 60, "network.ingress.proxy_send_timeout_seconds": 60, "network.ingress.proxy_read_timeout_seconds": 60, "network.ingress.proxy_buffering": "on", "network.ingress.proxy_request_buffering": "on", "network.ingress.grpc_send_timeout_seconds": 60, "network.ingress.grpc_read_timeout_seconds": 60, "network.ingress.whitelist_source_range": "0.0.0.0/0", "network.ingress.denylist_source_range": "", "network.ingress.extra_headers": "{\"X-Frame-Options\":\"DENY \",\"X-Content-Type-Options\":\"nosniff\"}", "network.ingress.basic_auth_env_var": "", "network.ingress.enable_sticky_session": false, "security.service_account_name": "", "hpa.cpu.average_utilization_percent": 60
}Edit advanced settings Edit advanced settings by returning table of advanced settings.
Request Body schema: application/json| deployment.custom_domain_check_enabled | boolean Default: true disable custom domain check when deploying an application
| | deployment.termination_grace_period_seconds | integer Default: 60 define how long in seconds an application is supposed to be stopped gracefully
@@ -4382,6 +4385,8 @@
| | network.ingress.proxy_connect_timeout_seconds | integer Default: 60 Sets a timeout (in seconds) for establishing a connection to a proxied server
| | network.ingress.proxy_send_timeout_seconds | integer Default: 60 Sets a timeout (in seconds) for transmitting a request to the proxied server
| | network.ingress.proxy_read_timeout_seconds | integer Default: 60 Sets a timeout (in seconds) for reading a response from the proxied server
+ | | network.ingress.proxy_buffering | string Default: "on" Allows to enable or disable nginx proxy-buffering
+ | | network.ingress.proxy_request_buffering | string Default: "on" Allows to enable or disable nginx proxy-request-buffering
| | network.ingress.grpc_send_timeout_seconds | integer Default: 60 Sets a timeout (in seconds) for transmitting a request to the grpc server
| | network.ingress.grpc_read_timeout_seconds | integer Default: 60 Sets a timeout (in seconds) for transmitting a request to the grpc server
| | network.ingress.whitelist_source_range | string Default: "0.0.0.0/0" list of source ranges to allow access to ingress proxy.
@@ -4391,6 +4396,7 @@
| | network.ingress.denylist_source_range | string Default: "" list of source ranges to deny access to ingress proxy.
This property can be used to blacklist source IP ranges for ingress proxy.
The value is a comma separated list of CIDRs, e.g. 10.0.0.0/24,172.10.0.1
+ | | network.ingress.extra_headers | string Default: "{}" Allows to define response headers
| | network.ingress.basic_auth_env_var | string Default: "" Set the name of an environment variable to use as a basic authentication (login:crypted_password) from htpasswd command. You can add multiples comma separated values.
| | network.ingress.enable_sticky_session | boolean Default: false Enable the load balancer to bind a user's session to a specific target.
This ensures that all requests from the user during the session are sent to the same target
@@ -4401,7 +4407,7 @@
https://api.qovery.com/container/{containerId}/advancedSettings Request samples Content typeapplication/json {"deployment.custom_domain_check_enabled": true, "deployment.termination_grace_period_seconds": 60, "deployment.affinity.node.required": {"property1": "string", "property2": "string"
}, "deployment.antiaffinity.pod": "Preferred", "deployment.update_strategy.type": "RollingUpdate", "deployment.update_strategy.rolling_update.max_unavailable_percent": 25, "deployment.update_strategy.rolling_update.max_surge_percent": 25, "network.ingress.proxy_body_size_mb": 100, "network.ingress.enable_cors": false, "network.ingress.cors_allow_origin": "*", "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS", "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization", "network.ingress.proxy_buffer_size_kb": 4, "network.ingress.keepalive_time_seconds": 3600, "network.ingress.keepalive_timeout_seconds": 60, "network.ingress.send_timeout_seconds": 60, "network.ingress.proxy_connect_timeout_seconds": 60, "network.ingress.proxy_send_timeout_seconds": 60, "network.ingress.proxy_read_timeout_seconds": 60, "network.ingress.grpc_send_timeout_seconds": 60, "network.ingress.grpc_read_timeout_seconds": 60, "network.ingress.whitelist_source_range": "0.0.0.0/0", "network.ingress.denylist_source_range": "", "network.ingress.basic_auth_env_var": "", "network.ingress.enable_sticky_session": false, "security.service_account_name": "", "hpa.cpu.average_utilization_percent": 60
} Response samples Content typeapplication/json {"deployment.custom_domain_check_enabled": true, "deployment.termination_grace_period_seconds": 60, "deployment.affinity.node.required": {"property1": "string", "property2": "string"
}, "deployment.antiaffinity.pod": "Preferred", "deployment.update_strategy.type": "RollingUpdate", "deployment.update_strategy.rolling_update.max_unavailable_percent": 25, "deployment.update_strategy.rolling_update.max_surge_percent": 25, "network.ingress.proxy_body_size_mb": 100, "network.ingress.enable_cors": false, "network.ingress.cors_allow_origin": "*", "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS", "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization", "network.ingress.proxy_buffer_size_kb": 4, "network.ingress.keepalive_time_seconds": 3600, "network.ingress.keepalive_timeout_seconds": 60, "network.ingress.send_timeout_seconds": 60, "network.ingress.proxy_connect_timeout_seconds": 60, "network.ingress.proxy_send_timeout_seconds": 60, "network.ingress.proxy_read_timeout_seconds": 60, "network.ingress.grpc_send_timeout_seconds": 60, "network.ingress.grpc_read_timeout_seconds": 60, "network.ingress.whitelist_source_range": "0.0.0.0/0", "network.ingress.denylist_source_range": "", "network.ingress.basic_auth_env_var": "", "network.ingress.enable_sticky_session": false, "security.service_account_name": "", "hpa.cpu.average_utilization_percent": 60
}Get Container Network information Get status of the container network settings.
+ https://api.qovery.com/container/{containerId}/advancedSettings Request samples Content typeapplication/json {"deployment.custom_domain_check_enabled": true, "deployment.termination_grace_period_seconds": 60, "deployment.affinity.node.required": {"property1": "string", "property2": "string"
}, "deployment.antiaffinity.pod": "Preferred", "deployment.update_strategy.type": "RollingUpdate", "deployment.update_strategy.rolling_update.max_unavailable_percent": 25, "deployment.update_strategy.rolling_update.max_surge_percent": 25, "network.ingress.proxy_body_size_mb": 100, "network.ingress.enable_cors": false, "network.ingress.cors_allow_origin": "*", "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS", "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization", "network.ingress.proxy_buffer_size_kb": 4, "network.ingress.keepalive_time_seconds": 3600, "network.ingress.keepalive_timeout_seconds": 60, "network.ingress.send_timeout_seconds": 60, "network.ingress.proxy_connect_timeout_seconds": 60, "network.ingress.proxy_send_timeout_seconds": 60, "network.ingress.proxy_read_timeout_seconds": 60, "network.ingress.proxy_buffering": "on", "network.ingress.proxy_request_buffering": "on", "network.ingress.grpc_send_timeout_seconds": 60, "network.ingress.grpc_read_timeout_seconds": 60, "network.ingress.whitelist_source_range": "0.0.0.0/0", "network.ingress.denylist_source_range": "", "network.ingress.extra_headers": "{\"X-Frame-Options\":\"DENY \",\"X-Content-Type-Options\":\"nosniff\"}", "network.ingress.basic_auth_env_var": "", "network.ingress.enable_sticky_session": false, "security.service_account_name": "", "hpa.cpu.average_utilization_percent": 60
} Response samples Content typeapplication/json {"deployment.custom_domain_check_enabled": true, "deployment.termination_grace_period_seconds": 60, "deployment.affinity.node.required": {"property1": "string", "property2": "string"
}, "deployment.antiaffinity.pod": "Preferred", "deployment.update_strategy.type": "RollingUpdate", "deployment.update_strategy.rolling_update.max_unavailable_percent": 25, "deployment.update_strategy.rolling_update.max_surge_percent": 25, "network.ingress.proxy_body_size_mb": 100, "network.ingress.enable_cors": false, "network.ingress.cors_allow_origin": "*", "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS", "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization", "network.ingress.proxy_buffer_size_kb": 4, "network.ingress.keepalive_time_seconds": 3600, "network.ingress.keepalive_timeout_seconds": 60, "network.ingress.send_timeout_seconds": 60, "network.ingress.proxy_connect_timeout_seconds": 60, "network.ingress.proxy_send_timeout_seconds": 60, "network.ingress.proxy_read_timeout_seconds": 60, "network.ingress.proxy_buffering": "on", "network.ingress.proxy_request_buffering": "on", "network.ingress.grpc_send_timeout_seconds": 60, "network.ingress.grpc_read_timeout_seconds": 60, "network.ingress.whitelist_source_range": "0.0.0.0/0", "network.ingress.denylist_source_range": "", "network.ingress.extra_headers": "{\"X-Frame-Options\":\"DENY \",\"X-Content-Type-Options\":\"nosniff\"}", "network.ingress.basic_auth_env_var": "", "network.ingress.enable_sticky_session": false, "security.service_account_name": "", "hpa.cpu.average_utilization_percent": 60
}Get Container Network information Get status of the container network settings.
Responseshttps://api.qovery.com/job/{jobId}/advancedSettings Request samples Content typeapplication/json {"build.timeout_max_sec": 1800, "build.cpu_max_in_milli": 4000, "build.ram_max_in_gib": 8, "deployment.termination_grace_period_seconds": 60, "deployment.affinity.node.required": {"property1": "string", "property2": "string"
}, "job.delete_ttl_seconds_after_finished": null, "cronjob.concurrency_policy": "Forbid", "cronjob.failed_jobs_history_limit": 1, "cronjob.success_jobs_history_limit": 1, "security.service_account_name": ""
} Response samples Content typeapplication/json {"build.timeout_max_sec": 1800, "build.cpu_max_in_milli": 4000, "build.ram_max_in_gib": 8, "deployment.termination_grace_period_seconds": 60, "deployment.affinity.node.required": {"property1": "string", "property2": "string"
}, "job.delete_ttl_seconds_after_finished": null, "cronjob.concurrency_policy": "Forbid", "cronjob.failed_jobs_history_limit": 1, "cronjob.success_jobs_history_limit": 1, "security.service_account_name": ""
}List currently running instances of the job with their CPU and RAM metrics path Parameters| jobId required | https://api.qovery.com/job/{jobId}/advancedSettings Request samples Content typeapplication/json {"build.timeout_max_sec": 1800, "build.cpu_max_in_milli": 4000, "build.ram_max_in_gib": 8, "deployment.termination_grace_period_seconds": 60, "deployment.affinity.node.required": {"property1": "string", "property2": "string"
}, "job.delete_ttl_seconds_after_finished": null, "cronjob.concurrency_policy": "Forbid", "cronjob.failed_jobs_history_limit": 1, "cronjob.success_jobs_history_limit": 1, "security.service_account_name": ""
} Response samples Content typeapplication/json {"build.timeout_max_sec": 1800, "build.cpu_max_in_milli": 4000, "build.ram_max_in_gib": 8, "deployment.termination_grace_period_seconds": 60, "deployment.affinity.node.required": {"property1": "string", "property2": "string"
}, "job.delete_ttl_seconds_after_finished": null, "cronjob.concurrency_policy": "Forbid", "cronjob.failed_jobs_history_limit": 1, "cronjob.success_jobs_history_limit": 1, "security.service_account_name": ""
}Job Deployment RestrictionGet job deployment restrictions Get job deployment restrictions
+ Responseshttps://api.qovery.com/job/{jobId}/deploymentRestriction Response samples Content typeapplication/json {"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "mode": "MATCH", "type": "PATH", "value": "job1/src/"
}
]
}Create a job deployment restriction Create a job deployment restriction
+ Request Body schema: application/json| mode required | string (DeploymentRestrictionModeEnum) Enum: "EXCLUDE" "MATCH" Match mode will rebuild app only if specified items are updated. Exclude mode will not rebuild app if specified items are updated.
+ | | type required | string (DeploymentRestrictionTypeEnum) Value: "PATH" | | value required | string For PATH restrictions, the value must not start with /
+ |
Responseshttps://api.qovery.com/job/{jobId}/deploymentRestriction Request samples Content typeapplication/json {"mode": "MATCH", "type": "PATH", "value": "job1/src/"
} Response samples Content typeapplication/json {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "mode": "MATCH", "type": "PATH", "value": "job1/src/"
}Edit a job deployment restriction Edit a job deployment restriction
+ path Parameters| jobId required | | | deploymentRestrictionId required | string <uuid> Deployment Restriction ID
+ |
Request Body schema: application/json| mode required | string (DeploymentRestrictionModeEnum) Enum: "EXCLUDE" "MATCH" Match mode will rebuild app only if specified items are updated. Exclude mode will not rebuild app if specified items are updated.
+ | | type required | string (DeploymentRestrictionTypeEnum) Value: "PATH" | | value required | string For PATH restrictions, the value must not start with /
+ |
Responseshttps://api.qovery.com/job/{jobId}/deploymentRestriction/{deploymentRestrictionId} Request samples Content typeapplication/json {"mode": "MATCH", "type": "PATH", "value": "job1/src/"
} Response samples Content typeapplication/json {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "mode": "MATCH", "type": "PATH", "value": "job1/src/"
}Delete a job deployment restriction Delete a job deployment restriction
+ path Parameters| jobId required | | | deploymentRestrictionId required | string <uuid> Deployment Restriction ID
+ |
Responseshttps://api.qovery.com/job/{jobId}/deploymentRestriction/{deploymentRestrictionId} List currently running instances of the job with their CPU and RAM metrics Responseshttps://api.qovery.com/job/{jobId}/instance Response samples Content typeapplication/json List job deployments Returns the 20 last job deployments
+ https://api.qovery.com/job/{jobId}/instance Response samples Content typeapplication/json List job deployments Returns the 20 last job deployments
Responseshttps://api.qovery.com/job/{jobId}/deploymentHistory Response samples Content typeapplication/json {"page": 1, "page_size": 20, "results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "status": "BUILDING", "image_name": "string", "tag": "string", "commit": {"created_at": "2019-08-24T14:15:22Z", "git_commit_id": "string", "tag": "v2.1.1", "message": "string", "author_name": "string", "author_avatar_url": "string", "commit_page_url": "string"
}, "schedule": {"event": "ON_START", "schedule_at": "string"
}, "entrypoint": "string"
}
]
}List environment variables path Parameters| jobId required | https://api.qovery.com/job/{jobId}/deploymentHistory Response samples Content typeapplication/json {"page": 1, "page_size": 20, "results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "status": "BUILDING", "image_name": "string", "tag": "string", "commit": {"created_at": "2019-08-24T14:15:22Z", "git_commit_id": "string", "tag": "v2.1.1", "message": "string", "author_name": "string", "author_avatar_url": "string", "commit_page_url": "string"
}, "schedule": {"event": "ON_START", "schedule_at": "string"
}, "entrypoint": "string"
}
]
}List environment variables Responseshttps://api.qovery.com/job/{jobId}/environmentVariable Response samples Content typeapplication/json {"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "key": "string", "value": "string", "mount_path": null, "overridden_variable": {}, "aliased_variable": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "QOVERY_DATABASE_PSQL_NAME", "value": "string", "mount_path": "string", "scope": "APPLICATION", "variable_type": "VALUE"
}, "scope": "APPLICATION", "variable_type": "VALUE", "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0", "service_name": "string", "service_type": "APPLICATION", "owned_by": "string"
}
]
}Add an environment variable to the job https://api.qovery.com/job/{jobId}/environmentVariable Response samples Content typeapplication/json {"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "key": "string", "value": "string", "mount_path": null, "overridden_variable": {}, "aliased_variable": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "QOVERY_DATABASE_PSQL_NAME", "value": "string", "mount_path": "string", "scope": "APPLICATION", "variable_type": "VALUE"
}, "scope": "APPLICATION", "variable_type": "VALUE", "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0", "service_name": "string", "service_type": "APPLICATION", "owned_by": "string"
}
]
}Add an environment variable to the job
- Add an environment variable to the job.
path Parameters| jobId required | string <uuid> Job ID
@@ -4916,14 +4954,14 @@
https://api.qovery.com/job/{jobId}/environmentVariable Request samples Content typeapplication/json {"key": "string", "value": "string", "mount_path": null
} Response samples Content typeapplication/json {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "key": "string", "value": "string", "mount_path": null, "overridden_variable": {}, "aliased_variable": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "QOVERY_DATABASE_PSQL_NAME", "value": "string", "mount_path": "string", "scope": "APPLICATION", "variable_type": "VALUE"
}, "scope": "APPLICATION", "variable_type": "VALUE", "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0", "service_name": "string", "service_type": "APPLICATION", "owned_by": "string"
}Import variables Import environment variables in a defined scope, with a defined visibility.
+ https://api.qovery.com/job/{jobId}/environmentVariable Request samples Content typeapplication/json {"key": "string", "value": "string", "mount_path": null
} Response samples Content typeapplication/json {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "key": "string", "value": "string", "mount_path": null, "overridden_variable": {}, "aliased_variable": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "QOVERY_DATABASE_PSQL_NAME", "value": "string", "mount_path": "string", "scope": "APPLICATION", "variable_type": "VALUE"
}, "scope": "APPLICATION", "variable_type": "VALUE", "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0", "service_name": "string", "service_type": "APPLICATION", "owned_by": "string"
}Import variables Import environment variables in a defined scope, with a defined visibility.
Request Body schema: application/json| overwrite required | | required | |
Responseshttps://api.qovery.com/job/{jobId}/environmentVariable/import Request samples Content typeapplication/json {"overwrite": false, "vars": [{"name": "string", "value": "string", "scope": "APPLICATION", "is_secret": true
}
]
} Response samples Content typeapplication/json Delete an environment variable from a job https://api.qovery.com/job/{jobId}/environmentVariable/import Request samples Content typeapplication/json {"overwrite": false, "vars": [{"name": "string", "value": "string", "scope": "APPLICATION", "is_secret": true
}
]
} Response samples Content typeapplication/json Delete an environment variable from a job
- To delete an environment variable from an job you must have the project user permission
- You can't delete a BUILT_IN variable
- If you delete a variable having override or alias, the associated override/alias will be deleted as well
@@ -4949,7 +4987,7 @@
https://api.qovery.com/job/{jobId}/environmentVariable/{environmentVariableId} Request samples Content typeapplication/json {"key": "string", "value": "string"
} Response samples Content typeapplication/json {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "key": "string", "value": "string", "mount_path": null, "overridden_variable": {}, "aliased_variable": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "QOVERY_DATABASE_PSQL_NAME", "value": "string", "mount_path": "string", "scope": "APPLICATION", "variable_type": "VALUE"
}, "scope": "APPLICATION", "variable_type": "VALUE", "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0", "service_name": "string", "service_type": "APPLICATION", "owned_by": "string"
}Create an environment variable override at the job level https://api.qovery.com/job/{jobId}/environmentVariable/{environmentVariableId} Request samples Content typeapplication/json {"key": "string", "value": "string"
} Response samples Content typeapplication/json {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "key": "string", "value": "string", "mount_path": null, "overridden_variable": {}, "aliased_variable": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "QOVERY_DATABASE_PSQL_NAME", "value": "string", "mount_path": "string", "scope": "APPLICATION", "variable_type": "VALUE"
}, "scope": "APPLICATION", "variable_type": "VALUE", "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0", "service_name": "string", "service_type": "APPLICATION", "owned_by": "string"
}Create an environment variable override at the job level
- Allows you to override at job level an environment variable that has a higher scope.
- You only have to specify a value in the request body
- The system will create a new environment variable at job level with the same key as the one corresponding to the variable id in the path
@@ -4963,7 +5001,7 @@
https://api.qovery.com/job/{jobId}/environmentVariable/{environmentVariableId}/override Request samples Content typeapplication/json Response samples Content typeapplication/json {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "key": "string", "value": "string", "mount_path": null, "overridden_variable": {}, "aliased_variable": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "QOVERY_DATABASE_PSQL_NAME", "value": "string", "mount_path": "string", "scope": "APPLICATION", "variable_type": "VALUE"
}, "scope": "APPLICATION", "variable_type": "VALUE", "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0", "service_name": "string", "service_type": "APPLICATION", "owned_by": "string"
}Create an environment variable alias at the job level https://api.qovery.com/job/{jobId}/environmentVariable/{environmentVariableId}/override Request samples Content typeapplication/json Response samples Content typeapplication/json {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "key": "string", "value": "string", "mount_path": null, "overridden_variable": {}, "aliased_variable": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "QOVERY_DATABASE_PSQL_NAME", "value": "string", "mount_path": "string", "scope": "APPLICATION", "variable_type": "VALUE"
}, "scope": "APPLICATION", "variable_type": "VALUE", "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0", "service_name": "string", "service_type": "APPLICATION", "owned_by": "string"
}Create an environment variable alias at the job level
- Allows you to add an alias at job level on an existing environment variable having higher scope, in order to customize its key.
- You only have to specify a key in the request body
- The system will create a new environment variable at job level with the same value as the one corresponding to the variable id in the path
@@ -4978,13 +5016,13 @@
https://api.qovery.com/job/{jobId}/environmentVariable/{environmentVariableId}/alias Request samples Content typeapplication/json Response samples Content typeapplication/json {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "key": "string", "value": "string", "mount_path": null, "overridden_variable": {}, "aliased_variable": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "QOVERY_DATABASE_PSQL_NAME", "value": "string", "mount_path": "string", "scope": "APPLICATION", "variable_type": "VALUE"
}, "scope": "APPLICATION", "variable_type": "VALUE", "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0", "service_name": "string", "service_type": "APPLICATION", "owned_by": "string"
}List job secrets Secrets are like environment variables, but they are secured and can't be revealed.
+ https://api.qovery.com/job/{jobId}/environmentVariable/{environmentVariableId}/alias Request samples Content typeapplication/json Response samples Content typeapplication/json {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "key": "string", "value": "string", "mount_path": null, "overridden_variable": {}, "aliased_variable": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "QOVERY_DATABASE_PSQL_NAME", "value": "string", "mount_path": "string", "scope": "APPLICATION", "variable_type": "VALUE"
}, "scope": "APPLICATION", "variable_type": "VALUE", "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0", "service_name": "string", "service_type": "APPLICATION", "owned_by": "string"
}List job secrets Secrets are like environment variables, but they are secured and can't be revealed.
Responseshttps://api.qovery.com/job/{jobId}/secret Response samples Content typeapplication/json {"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "key": "string", "aliased_secret": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "QOVERY_DATABASE_PSQL_NAME", "mount_path": "string", "scope": "APPLICATION", "variable_type": "VALUE"
}, "scope": "APPLICATION", "variable_type": "VALUE", "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0", "service_name": "string", "service_type": "APPLICATION", "owned_by": "string"
}
]
}https://api.qovery.com/job/{jobId}/secret Response samples Content typeapplication/json {"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "key": "string", "aliased_secret": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "QOVERY_DATABASE_PSQL_NAME", "mount_path": "string", "scope": "APPLICATION", "variable_type": "VALUE"
}, "scope": "APPLICATION", "variable_type": "VALUE", "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0", "service_name": "string", "service_type": "APPLICATION", "owned_by": "string"
}
]
}Add a secret to the job path Parameters| jobId required | string <uuid> Job ID
@@ -4996,7 +5034,7 @@
https://api.qovery.com/job/{jobId}/secret Request samples Content typeapplication/json {"key": "string", "value": "string", "mount_path": null
} Response samples Content typeapplication/json {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "key": "string", "aliased_secret": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "QOVERY_DATABASE_PSQL_NAME", "mount_path": "string", "scope": "APPLICATION", "variable_type": "VALUE"
}, "scope": "APPLICATION", "variable_type": "VALUE", "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0", "service_name": "string", "service_type": "APPLICATION", "owned_by": "string"
}Delete a secret from an job https://api.qovery.com/job/{jobId}/secret Request samples Content typeapplication/json {"key": "string", "value": "string", "mount_path": null
} Response samples Content typeapplication/json {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "key": "string", "aliased_secret": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "QOVERY_DATABASE_PSQL_NAME", "mount_path": "string", "scope": "APPLICATION", "variable_type": "VALUE"
}, "scope": "APPLICATION", "variable_type": "VALUE", "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0", "service_name": "string", "service_type": "APPLICATION", "owned_by": "string"
}Delete a secret from an job
- To delete a secret you must have the project user permission
- You can't delete a BUILT_IN secret
- If you delete a secret having override or alias, the associated override/alias will be deleted as well
@@ -5020,7 +5058,7 @@
https://api.qovery.com/job/{jobId}/secret/{secretId} Request samples Content typeapplication/json {"value": "string", "key": "string"
} Response samples Content typeapplication/json {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "key": "string", "aliased_secret": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "QOVERY_DATABASE_PSQL_NAME", "mount_path": "string", "scope": "APPLICATION", "variable_type": "VALUE"
}, "scope": "APPLICATION", "variable_type": "VALUE", "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0", "service_name": "string", "service_type": "APPLICATION", "owned_by": "string"
}Create a secret override at the job level https://api.qovery.com/job/{jobId}/secret/{secretId} Request samples Content typeapplication/json {"value": "string", "key": "string"
} Response samples Content typeapplication/json {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "key": "string", "aliased_secret": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "QOVERY_DATABASE_PSQL_NAME", "mount_path": "string", "scope": "APPLICATION", "variable_type": "VALUE"
}, "scope": "APPLICATION", "variable_type": "VALUE", "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0", "service_name": "string", "service_type": "APPLICATION", "owned_by": "string"
}Create a secret override at the job level
- Allows you to override at job level a secret that has a higher scope.
- You only have to specify a value in the request body
- The system will create a new secret at job level with the same key as the one corresponding to the secret id in the path
@@ -5034,7 +5072,7 @@
https://api.qovery.com/job/{jobId}/secret/{secretId}/override Request samples Content typeapplication/json Response samples Content typeapplication/json {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "key": "string", "aliased_secret": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "QOVERY_DATABASE_PSQL_NAME", "mount_path": "string", "scope": "APPLICATION", "variable_type": "VALUE"
}, "scope": "APPLICATION", "variable_type": "VALUE", "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0", "service_name": "string", "service_type": "APPLICATION", "owned_by": "string"
}Create a secret alias at the job level https://api.qovery.com/job/{jobId}/secret/{secretId}/override Request samples Content typeapplication/json Response samples Content typeapplication/json {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "key": "string", "aliased_secret": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "QOVERY_DATABASE_PSQL_NAME", "mount_path": "string", "scope": "APPLICATION", "variable_type": "VALUE"
}, "scope": "APPLICATION", "variable_type": "VALUE", "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0", "service_name": "string", "service_type": "APPLICATION", "owned_by": "string"
}Create a secret alias at the job level
- Allows you to add an alias at job level on an existing secret having higher scope, in order to customize its key.
- You only have to specify a key in the request body
- The system will create a new secret at job level with the same value as the one corresponding to the secret id in the path
@@ -5049,51 +5087,51 @@
https://api.qovery.com/job/{jobId}/secret/{secretId}/alias Request samples Content typeapplication/json Response samples Content typeapplication/json {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "key": "string", "aliased_secret": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "QOVERY_DATABASE_PSQL_NAME", "mount_path": "string", "scope": "APPLICATION", "variable_type": "VALUE"
}, "scope": "APPLICATION", "variable_type": "VALUE", "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0", "service_name": "string", "service_type": "APPLICATION", "owned_by": "string"
} |
|
|
|
|
|
