Узнайте о запросе cURL POST, что это такое, как отправить запрос POST с помощью cURL и многое другое.
4 мин. чтения
curl – это инструмент командной строки для передачи данных по различным сетевым протоколам. Доступный на всех основных операционных системах, curl стал стандартным инструментом для отправки HTTP-запросов из командной строки.
Кроссплатформенная утилита curl поддерживает такие протоколы, как HTTP, HTTPS, FTP и IMAP, что позволяет легко отправлять запросы к API и парсить веб-сайты с помощью curl. Благодаря широкой доступности и поддержке множества протоколов, вы часто можете встретить ссылки на curl в документации по REST API как на быстрый способ тестирования вызовов API непосредственно из командной строки:
В этой статье вы узнаете, как отправлять POST-запросы с помощью curl из командной строки.
Что такое POST-запрос
POST-запрос – это метод HTTP для отправки данных на сервер, один из самых распространенных методов HTTP.
Когда вы отправляете POST-запрос, передаваемые данные включаются в тело запроса. Это позволяет отправлять данные более скрытно, чем в URL (как в случае с GET-запросом). Вы также можете отправить значительно больше данных в POST-запросе, обходя ограничения на длину URL, накладываемые браузерами на GET-запросы.
POST-запросы часто используются для отправки форм, загрузки файлов или передачи JSON-данных в API. По сравнению с GET, POST-запросы обычно не кэшируются, и данные не отображаются в истории браузера, поскольку они содержатся в теле запроса.
Как отправить POST-запрос с помощью curl
Прежде чем приступить к этому уроку, вам необходимо установить curl на свой компьютер. Выполните следующую команду, чтобы проверить, установлен ли curl:
curl --version
Если вы получаете ошибку о том, что команда не найдена, вам нужно установить утилиту
Установите curl
Ниже приведены инструкции по установке curl на все основные операционные системы:
Windows
В Windows для установки curl можно использовать WinGet, менеджер пакетов по умолчанию в Windows 11:
winget install curl.curl
Chocolatey – это еще один менеджер пакетов для Windows, который позволяет установить curl с помощью следующей команды:
choco install curl
Linux
curl доступен в большинстве менеджеров пакетов Linux. На Ubuntu/Debian для установки curl используйте следующую команду:
apt-get install curl
Red Hat Enterprise Linux (RHEL), CentOS и Fedora позволяют установить curl с помощью Yellowdog Updater Modified (YUM), например, так:
yum install curl
Если вы используете OpenSUSE, вы можете установить curl с помощью следующей команды в терминале:
zypper install curl
Наконец, Arch Linux позволяет использовать pacman для установки curl с помощью этой команды:
pacman -Sy curl
macOS
Homebrew – это самый простой способ установить curl на macOS. Убедитесь, что у вас установлен Homebrew, а затем выполните следующую команду:
brew install curl
Теперь, когда вы установили curl на свою операционную систему, вы готовы узнать, как выполнять POST-запросы.
Выполните POST-запрос
curl позволяет указать несколько параметров при отправке POST-запросов. В следующих разделах будут показаны некоторые общие возможности curl, с которыми вы можете столкнуться при выполнении POST-запросов с помощью этой утилиты.
Укажите метод POST
При выполнении HTTP-запросов с помощью curl необходимо указать HTTP-метод, который вы хотите использовать. К HTTP-методам относятся GET, POST, PUT и DELETE. curl позволяет указать HTTP-метод, который вы хотите использовать, с помощью флага командной строки -X
.
Например, чтобы отправить POST-запрос на https://httpbin.org/anything
, вы можете выполнить в терминале следующую команду curl:
curl -X POST https://httpbin.org/anything
httpbin.org повторяет тело запроса и заголовки в ответе. Ваш ответ должен выглядеть следующим образом:
{
"args": {},
"data": "",
"files": {},
"form": {},
"headers": {
"Accept": "*/*",
"Host": "httpbin.org",
"User-Agent": "curl/8.1.2",
"X-Amzn-Trace-Id": "Root=1-11111111-111111111111111111111111"
},
"json": null,
"method": "POST",
"origin": "0.0.0.0",
"url": "https://httpbin.org/anything"
}
Флаг -X POST
эквивалентен использованию флага --request
POST, поэтому вы также можете выполнить следующую команду и получить тот же результат:
curl --request POST https://httpbin.org/anything
Ответ выглядит так же, как и предыдущий.
Подробнее о флагах -X
и --request
вы можете прочитать в официальной документации.
Установите тип содержимого
При отправке POST-запроса важно указать тип отправляемого содержимого в теле запроса, чтобы сервер мог правильно интерпретировать тело запроса. Вы можете использовать типы MIME в заголовке Content-Type
в HTTP-запросе, чтобы указать формат тела запроса.
Например, если вы отправляете JSON в теле запроса, вам нужно указать веб-серверу, что он ожидает JSON-содержимое, установив в заголовке Content-Type
значение application/json
. Если вы отправляете XML, заголовок Content-Type
должен быть application/xml
. Для получения дополнительной информации ознакомьтесь с официальной документацией по Content-Type
.
curl позволяет задать заголовки для HTTP-запроса с помощью флага -H
. Например, если вы отправляете JSON в POST-запросе, следующая команда curl показывает, как вы можете установить заголовок Content-Type
для запроса:
curl -X POST -H 'Content-Type: application/json' -d '{}' https://httpbin.org/anything
В ответе можно увидеть, что в заголовке Content-Type
установлено значение application/json
:
{
"args": {},
"data": "{}",
"files": {},
"form": {},
"headers": {
"Accept": "*/*",
"Content-Length": "2",
"Content-Type": "application/json",
"Host": "httpbin.org",
"User-Agent": "curl/8.1.2",
"X-Amzn-Trace-Id": "Root=-11111111-111111111111111111111111"
},
"json": {},
"method": "POST",
"origin": "0.0.0.0",
"url": "https://httpbin.org/anything"
}
Флаг -H
также может быть указан с помощью более длинного флага --header
. В этом случае ваша команда curl будет выглядеть следующим образом:
curl -X POST --header 'Content-Type: application/json' -d '{}' https://httpbin.org/anything
Ваш ответ будет выглядеть так же, как и предыдущий.
Отправьте данные
Вы могли заметить, что в предыдущих командах был флаг -d
. Этот флаг позволяет указать данные для отправки в теле запроса. С помощью этого флага можно передать любую строку значений, заключенную в кавычки, например, так:
curl -X POST -H 'Content-Type: application/json' -d '{
"FirstName": "Joe",
"LastName": "Soap"
}' https://httpbin.org/anything
Вы заметите, что httpbin.org показывает данные тела, которые вы отправили, в свойстве data
ответа.
Если у вас есть файл с данными, которые вы хотите, чтобы curl отправил в тело запроса, укажите имя файла с префиксом @
. Следующая команда считывает содержимое файла body.json
и отправляет его в теле запроса:
curl -X POST -H 'Content-Type: application/json' -d @body.json https://httpbin.org/anything
В этом случае файл body.json
содержит следующее:
{
"FirstName": "Joe",
"LastName": "Soap"
}
При отправке этого сообщения httpbin.org должен вернуть следующий ответ:
{
"args": {},
"data": "{\t\"FirstName\": \"Joe\",\t\"LastName\": \"Soap\"}",
"files": {},
"form": {},
"headers": {
"Accept": "*/*",
"Content-Length": "41",
"Content-Type": "application/json",
"Host": "httpbin.org",
"User-Agent": "curl/8.1.2",
"X-Amzn-Trace-Id": "Root=1-11111111-111111111111111111111111"
},
"json": {
"FirstName": "Joe",
"LastName": "Soap"
},
"method": "POST",
"origin": "0.0.0.0",
"url": "https://httpbin.org/anything"
}
Флаг--data
ведет себя так же, как и -d
, поэтому их можно использовать как взаимозаменяемые.
Отправьте данные в формате JSON
В предыдущем разделе вы узнали, как можно отправить JSON-данные, установив в заголовке Content-Type
значение application/json
, а затем передав JSON-данные с помощью флага -d
. При отправке запроса также важно сообщить веб-серверу, какой формат данных вы ожидаете получить в ответ. Вы можете использовать заголовок Accept
со значением application/json
, чтобы сообщить веб-серверу, что вы хотите получить ответ в формате JSON.
Следующая команда отправляет запрос JSON на сервер и сообщает серверу, что вы хотите получить JSON в ответ:
curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
"FirstName": "Joe",
"LastName": "Soap"
}' https://httpbin.org/anything
Вы заметите, что свойства data
и json
в теле ответа содержат данные JSON, которые вы отправили в запросе:
{
"args": {},
"data": "{\n \"FirstName\": \"Joe\",\n \"LastName\": \"Soap\"\n}",
"files": {},
"form": {},
"headers": {
"Accept": "application/json",
"Content-Length": "50",
"Content-Type": "application/json",
"Host": "httpbin.org",
"User-Agent": "curl/8.1.2",
"X-Amzn-Trace-Id": "Root=1-11111111-111111111111111111111111"
},
"json": {
"FirstName": "Joe",
"LastName": "Soap"
},
"method": "POST",
"origin": "0.0.0.0",
"url": "https://httpbin.org/anything"
}
Отправка и получение JSON-данных – обычное дело при отправке HTTP-запросов, поэтому curl предлагает флаг --json
, который устанавливает для вас заголовки Content-Type
и Accept
и отправляет JSON-данные в теле запроса. Используя этот флаг, вы можете сократить свою команду для отправки JSON в POST-запросе:
curl -X POST --json '{
"FirstName": "Joe",
"LastName": "Soap"
}' https://httpbin.org/anything
Это дает тот же ответ, что и раньше:
{
"args": {},
"data": "{\n \"FirstName\": \"Joe\",\n \"LastName\": \"Soap\"\n}",
"files": {},
"form": {},
"headers": {
"Accept": "application/json",
"Content-Length": "50",
"Content-Type": "application/json",
"Host": "httpbin.org",
"User-Agent": "curl/8.1.2",
"X-Amzn-Trace-Id": "Root=1-11111111-111111111111111111111111"
},
"json": {
"FirstName": "Joe",
"LastName": "Soap"
},
"method": "POST",
"origin": "0.0.0.0",
"url": "https://httpbin.org/anything"
}
Флаг--json
был выпущен в версии 7.82 curl в марте 2022 года, поэтому перед его использованием убедитесь, что у вас установлена последняя версия curl.
Отправка XML-данных
Curl также позволяет отправлять данные в других форматах, например XML. Чтобы отправить XML-данные, необходимо установить в заголовке Content-Type
значение application/xml
и передать XML-данные в теле запроса с помощью флага -d
. Вы также можете сообщить веб-серверу, что ожидаете получить ответ в формате XML, установив в заголовке Accept
значение application/xml
.
Следующая команда показывает, как можно отправить XML-объект в POST-запросе с помощью curl:
curl -X POST -H 'Content-Type: application/xml' -H 'Accept: application/xml' -d '<Person>
<FirstName>Joe</FirstName>
<LastName>Soap</LastName>
</Person>' https://httpbin.org/anything
Вы найдете данные XML-запроса в свойстве data
, возвращаемом httpbin.org:
{
"args": {},
"data": "<Person>\n <FirstName>Joe</FirstName>\n <LastName>Soap</LastName>\n</Person>",
"files": {},
"form": {},
"headers": {
"Accept": "application/xml",
"Content-Length": "79",
"Content-Type": "application/xml",
"Host": "httpbin.org",
"User-Agent": "curl/8.1.2",
"X-Amzn-Trace-Id": "Root=1-11111111-111111111111111111111111"
},
"json": null,
"method": "POST",
"origin": "0.0.0.0",
"url": "https://httpbin.org/anything"
}
Отправьте данные формы
Вы можете использовать FormData
для отправки пар ключ-значение данных на веб-сервер. Как следует из названия, этот формат данных используется при отправке формы на веб-странице. Пары ключ-значение содержат имя поля и значение.
curl позволяет указывать FormData
с помощью флага-F или –form. При использовании этого флага укажите имя и значение поля в следующем формате: -F <name=content>
or --form <name=content>
.
Следующий фрагмент показывает команду curl, которая отправляет POST-запрос с использованием FormData
с полями FirstName
и LastName
:
curl -X POST -F FirstName=Joe -F LastName=Soap https://httpbin.org/anything
Имена и значения полей формы вы найдете в свойстве form
объекта ответа httpbin.org:
{
"args": {},
"data": "",
"files": {},
"form": {
"FirstName": "Joe",
"LastName": "Soap"
},
"headers": {
"Accept": "*/*",
"Content-Length": "248",
"Content-Type": "multipart/form-data; boundary=------------------------e2bb56049a60b8b8",
"Host": "httpbin.org",
"User-Agent": "curl/8.1.2",
"X-Amzn-Trace-Id": "Root=1-11111111-111111111111111111111111"
},
"json": null,
"method": "POST",
"origin": "0.0.0.0",
"url": "https://httpbin.org/anything"
}
Используйте флаг -F
для каждого поля, которое вы хотите отправить на сервер.
Загрузите файлы
Вы можете использовать FormData
для загрузки файлов в POST-запросе, прикрепляя файл к полю. Чтобы сообщить curl о том, что поле FormData
содержит файл, введите путь к файлу в значение поля с префиксом @
.
Следующая команда curl загружает файл Contract.pdf
в ваш рабочий каталог. Для загрузки файла команда использует поле под названием File
:
curl -X POST -F [email protected] https://httpbin.org/anything
Ответ содержит весь файл, поэтому он длинный, но должен выглядеть так:
{
"args": {},
"data": "",
"files": {
"File": "..."
},
"form": {},
"headers": {
"Accept": "*/*",
"Content-Length": "246",
"Content-Type": "multipart/form-data; boundary=------------------------19ed1fc3be4d30c7",
"Host": "httpbin.org",
"User-Agent": "curl/8.1.2",
"X-Amzn-Trace-Id": "Root=1-11111111-111111111111111111111111"
},
"json": null,
"method": "POST",
"origin": "0.0.0.0",
"url": "https://httpbin.org/anything"
}
Отправьте учетные данные
Многие конечные точки HTTP требуют аутентификации для отправки запросов. Веб-сервер решает, какой метод аутентификации следует использовать. Одним из таких методов является базовая схема аутентификации, которая позволяет отправлять в запросе учетные данные, состоящие из имени пользователя и пароля. Затем сервер проверяет учетные данные и, если они верны, обрабатывает запрос
сurl упрощает отправку базовых учетных данных аутентификации с помощью флага -u
или --user
. Затем вы указываете имя пользователя и пароль, разделяя их символом :
(двоеточие), например: -u <username:password>
.
Следующий фрагмент использует curl для отправки POST-запроса с учетными данными пользователя и телом в формате JSON:
curl -X POST -u 'admin:password123' --json '{
"FirstName": "Joe",
"LastName": "Soap"
}' https://httpbin.org/anything
Обратите внимание, как curl кодирует имя пользователя и пароль и отправляет их в заголовке Authorization
:
{
"args": {},
"data": "{\n \"FirstName\": \"Joe\",\n \"LastName\": \"Soap\"\n}",
"files": {},
"form": {},
"headers": {
"Accept": "application/json",
"Authorization": "Basic YWRtaW46cGFzc3dvcmQxMjM=",
"Content-Length": "50",
"Content-Type": "application/json",
"Host": "httpbin.org",
"User-Agent": "curl/8.1.2",
"X-Amzn-Trace-Id": "Root=1-11111111-111111111111111111111111"
},
"json": {
"FirstName": "Joe",
"LastName": "Soap"
},
"method": "POST",
"origin": "0.0.0.0",
"url": "https://httpbin.org/anything"
}
Заключение
В этой статье вы узнали, как отправлять POST-запросы с помощью утилиты командной строки curl. Вы поняли, как использовать флаг -X
, чтобы указать, что вы хотите отправить POST-запрос. Вы также установили заголовки Content-Type
и Accept
с помощью флагов -H
и ---header
, чтобы веб-сервер знал, в каком формате отправляются данные. Чтобы отправить данные в теле запроса, используйте флаг -d
вместе с данными, которые вы хотите отправить.
Вы также увидели несколько примеров отправки нескольких типов данных, включая JSON, XML и FormDataa
, и узнали, как отправлять базовые учетные данные аутентификации в запросе с помощью флагов -u
и --user
.
Хотя в этой статье были показаны основные флаги, входящие в состав curl, и способы их использования, curl предлагает больше возможностей, которые вы можете изучить, включая использование переменных, отправку cookies с запросами и отправку запросов с помощью прокси. Многие языки программирования также предоставляют библиотеки, позволяющие работать с curl из этого языка, включая Python, Node.js и Rust.
Ищете решение для скрапинга? Поговорите с одним из наших экспертов по данным и узнайте, какой из наших продуктов лучше всего подходит для ваших потребностей.
Кредитная карта не требуется
#статьи
-
0
Осваиваем швейцарский нож для взаимодействия с сетевыми протоколами.
Иллюстрация: Оля Ежак для Skillbox Media
Филолог и технарь, пишет об IT так, что поймут даже новички. Коммерческий редактор, автор технических статей для vc.ru и «Хабра».
Curl (Client URL, или «Клиентский URL») — это инструмент командной строки, предназначенный для передачи данных по различным сетевым протоколам. Он помогает разработчикам, системным администраторам и другим специалистам выполнять HTTP-запросы, загружать файлы, тестировать API и решать множество задач по отладке веб-приложений.
Давайте сразу проверим Curl в действии. Для этого откройте на своём компьютере терминал, скопируйте следующую команду и нажмите Enter:
curl https://httpbin.org/ip
После ввода команды Curl отправит GET-запрос на сервис httpbin.org, который обработает запрос и вернёт ваш текущий IP-адрес в формате JSON:
C:\Users\user>curl https://httpbin.org/ip { "origin": "95.165.134.78" }
Похожим образом Curl позволяет легко взаимодействовать с различными API и получать нужную информацию. Теперь поговорим об этом подробней.
Содержание
- Описание Curl
- Установка и запуск
- Синтаксис команд
- Использование Curl
- GET-запрос
- POST-запрос
- Скачивание файла
- Вывод заголовков
- Аутентификация
- Следование редиректам
- Загрузка файла
- Подборка ресурсов для работы с Curl
В 1997 году шведский программист Даниэль Стенберг разработал утилиту httpget — инструмент для загрузки валютных курсов через IRC-бота. Если вы хотели узнать текущий курс доллара, процесс выглядел примерно так:
- Бот подключался к сайту с актуальными курсами валют.
- Программа httpget загружала страницу и извлекала нужные данные о курсе доллара. Например, 1 USD = 30 RUB ?
- Затем она передавала эту информацию IRC-боту, который отвечал на ваш запрос в IRC-чате.
Проект привлёк внимание многих разработчиков, поскольку решал актуальную проблему того времени — загрузку данных из интернета. До появления httpget разработчикам приходилось создавать отдельные скрипты для каждого случая получения данных. Программа позволяла получить нужную информацию всего несколькими простыми командами.
Со временем проект HTTPget сменил название на Urlget, а затем на Curl. Сегодня Curl — это кросс-платформенная утилита командной строки, которая позволяет передавать или загружать данные с сервера, устанавливая подключение через различные протоколы: HTTP, HTTPS, FTP, SFTP, TFTP, SCP, Telnet, DICT, LDAP, POP3, IMAP, SMTP и другие.
Сейчас, помимо Curl, существуют и другие инструменты для работы с HTTP-запросами. Вот некоторые из популярных:
- Wget — утилита командной строки для загрузки файлов, удобная для рекурсивной загрузки и работы с FTP-протоколом.
- Postman — графический инструмент для тестирования API. Он лучше Curl подходит для сложных запросов и визуализации ответов, однако уступает в гибкости при автоматизации задач.
- HTTPie — это современный аналог Curl с упрощённым синтаксисом, цветным выводом результатов и менее широким набором функций.
- Axios — это JavaScript-библиотека для выполнения HTTP-запросов. Она удобна для веб-разработки, но ограничена средой JavaScript: Axios можно использовать только в браузерах для HTTP-запросов на стороне клиента и в Node.js для запросов на стороне сервера.
Несмотря на множество альтернатив, Curl остаётся популярным инструментом благодаря своей универсальности, широкой поддержке протоколов и кросс-платформенности. Давайте перейдём к его установке.
? Возможности Curl и других бесплатных инструментов для передачи данных: сравнительная таблица
В современных операционных системах утилита Curl обычно установлена по умолчанию. Для проверки откройте терминал и введите команду:
curl --version
Должен отобразиться номер версии и поддерживаемые протоколы:
Скриншот: Windows 10 / Skillbox Media
Если Curl не установлен, в терминале появится сообщение об ошибке:
'curl' is not recognized as an internal or external command,
operable program or batch file.
Если вы видите подобное сообщение, значит, программа Curl недоступна и её нужно загрузить. Способ установки зависит от операционной системы.
Если у вас macOS, установите менеджер пакетов Homebrew и выполните в терминале следующую команду:
brew install curl
После завершения установки проверьте версию Curl:
curl --version
Если у вас Linux, то способ установки будет зависеть от дистрибутива. Для Ubuntu или Debian выполните последовательно следующие команды:
sudo apt-get update sudo apt-get install curl
Для Fedora:
sudo dnf install curl
Для CentOS или RHEL:
sudo yum install curl
Для Arch Linux:
sudo pacman -S curl
После установки проверьте версию Curl командой:
curl --version
Если у вас Windows 10 или 11, откройте PowerShell или командную строку от имени администратора и установите Curl через менеджер пакетов:
winget install curl
После установки перезапустите PowerShell или командную строку и проверьте установку:
curl --version
Если у вас Windows 7, 8 или 8.1, скачайте архив с утилитой с сайта curl.se через браузер Pale Moon. Современные браузеры могут не поддерживаться устаревшими версиями Windows или блокировать загрузку по соображениям безопасности. Pale Moon — это легковесный браузер, позволяющий загружать сторонние файлы без подобных ограничений.
После загрузки распакуйте папку из архива, переименуйте её в Curl и поместите в удобное место. Например, наша папка находится по пути: C:/Program Files/Curl. Затем откройте папку Curl, перейдите в подпапку bin и скопируйте полный путь к этому каталогу:
Не выходя из проводника, щёлкните правой кнопкой мыши по разделу Компьютер и в появившемся меню выберите пункт Свойства:
Откроется информационное окно со сведениями о вашем компьютере. В левой панели щёлкните на пункт Дополнительные параметры системы:
В открывшемся окне нажмите кнопку Переменные среды:
В разделе Системные переменные найдите пункт Path, выделите его и нажмите кнопку Изменить:
Появится окно Изменение системной переменной, в котором вам нужна строка Значение переменной. Поставьте точку с запятой в конце текущего значения и сразу после него без пробела вставьте скопированный путь к каталогу. Нажмите ОК во всех открытых окнах и перезагрузите компьютер:
После перезагрузки откройте командную строку и выполните проверку:
curl --version
Если отобразилась версия утилиты, значит, всё правильно. Если появилось сообщение об ошибке или команда не распознана, попробуйте следующее:
- Проверьте путь к Curl в разделе Переменные среды Path — убедитесь, что вы добавили его согласно инструкции.
- Перезапустите командную строку или PowerShell.
- Если проблема сохраняется, перезагрузите компьютер ещё раз.
- Если ничего не помогло, повторите процедуру установки.
Общий синтаксис Curl-команд выглядит следующим образом:
curl [параметры] [URL]
Базовые команды можно выполнять без параметров по указанию URL-адреса. Например, с помощью следующей команды вы сможете загрузить HTML-структуру выбранного сайта в свой терминал:
# Замените example.com на адрес любого сайта
curl https://www.example.com
Хотя параметры необязательны, они позволяют точно настроить поведение Curl и расширить его функциональность. Вот несколько частых параметров:
- -O: сохраняет скачиваемый файл с его оригинальным именем;
- -o: сохраняет файл с указанным вами именем;
- -I: получает только HTTP-заголовки ответа сервера;
- -L: следует редиректам. Например, если сайт перенаправляет запрос с http://example.com на https://example.com, curl с параметром -L автоматически выполнит это перенаправление.
Параметры всегда должны располагаться перед URL и их можно комбинировать. Вот пример комбинированной команды:
curl -LO <https://example.com/file.zip>
# Эта команда следует редиректам (-L) и сохраняет файл с оригинальным именем (-O)
Для просмотра всех доступных параметров используйте команду:
curl --help all
В следующем разделе мы рассмотрим основные сценарии использования Curl и попрактикуемся применять команды с различными параметрами.
Рассмотрим команды для основных сценариев использования Curl:
- GET-запрос: curl https://example.com
- POST-запрос: curl -X POST -d «data» https://example.com
- Скачивание файла: curl -O https://example.com/file.zip
- Вывод заголовков: curl -I https://example.com
- Аутентификация: curl -u username:password https://example.com
- Следование редиректам: curl -L https://example.com
- Загрузка файла: curl -T file.txt https://example.com/upload
Для закрепления этих команд воспользуемся сервисом JSONPlaceholder. Это бесплатный онлайн REST API, предоставляющий фиктивные данные для обучения и тестирования. Данный ресурс позволяет практиковаться в работе с API без настройки собственного сервера.
Эта команда позволяет получать данные с сервера без их изменения. С её помощью вы можете просматривать содержимое ресурса, проверять доступность API или проводить отладку приложения.
Отправим GET-запрос для получения информации о посте:
curl https://jsonplaceholder.typicode.com/posts/1
В результате мы получим примерно такой JSON-объект:
{ "userId": 1, "id": 1, "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit", "body": "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto" }
В ответе содержится информация о посте: идентификатор пользователя (userId), идентификатор поста (id), заголовок (title) и содержание (body). Поскольку сервис JSONPlaceholder предоставляет фиктивные данные, содержимое вашего поста может отличаться от приведённого примера.
Эта команда применяется для передачи данных на сервер при заполнении веб-форм, отправке сообщений или создании новых записей в базе данных.
Создадим новый пост и отправим на сервер следующие JSON-данные:
{ "title": "Заголовок поста", "body": "Здесь мы добавляем содержание поста", "userId": 1 }
Выполним Curl-команду:
curl -X POST -H "Content-Type: application/json" -d "{\"title\": \"Заголовок поста\", \"body\": \"Здесь мы добавляем содержание поста\", \"userId\": 1}" "https://jsonplaceholder.typicode.com/posts"
После обработки запроса сервер вернёт ответ, в котором содержится информация о созданном посте с его уникальным идентификатором:
{ "title": "Заголовок поста", "body": "Здесь мы добавляем содержание поста", "userId": 1, "id": 101 }
Эта команда позволяет сохранить полученные данные в файл на вашем компьютере. Это удобно при работе с большими объёмами данных или когда требуется дальнейшая обработка полученной информации.
Сохраним JSON-ответ в файл post.json в нашей текущей директории:
curl -o post.json https://jsonplaceholder.typicode.com/posts/1
Результат вывода:
C:\Users\user>curl -o post.json https://jsonplaceholder.typicode.com/posts/1 % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 100 292 100 292 0 0 380 0 --:--:-- --:--:-- --:--:-- 382
Файл post.json сохранён в директории C:\Users\user. Вывод также содержит статистику загрузки данных:
- Общий размер файла: 292 байта.
- Процент загрузки: 100%.
- Скорость загрузки: 380 байт/с.
- Время выполнения: мгновенно (—:—:—).
Эта команда позволяет получить заголовки HTTP-ответов без тела сообщения. Это полезно для проверки статуса ответа, типа содержимого, заголовков кэширования и других метаданных с запрашиваемого ресурса.
Отправим запрос для получения HTTP-заголовков из нашего сервиса:
curl -I https://jsonplaceholder.typicode.com/posts/1
Пример ответа:
HTTP/1.1 200 OK Date: Wed, 23 Oct 2024 07:34:44 GMT Content-Type: application/json; charset=utf-8 Content-Length: 292 Connection: keep-alive Report-To: {"group":"heroku-nel","max_age":3600,"endpoints":[{"url":"https://nel.heroku.com/reports?ts=1729551695&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=T06zv%2Bip6vp%2FcW6OahKqDwFYY1PQhd6eXYmDv1DMf3g%3D"}]} Reporting-Endpoints: heroku-nel=https://nel.heroku.com/reports?ts=1729551695&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=T06zv%2Bip6vp%2FcW6OahKqDwFYY1PQhd6eXYmDv1DMf3g%3D Nel: {"report_to":"heroku-nel","max_age":3600,"success_fraction":0.005,"failure_fraction":0.05,"response_headers":["Via"]} X-Powered-By: Express X-Ratelimit-Limit: 1000 X-Ratelimit-Remaining: 999 X-Ratelimit-Reset: 1729551747 Vary: Origin, Accept-Encoding Access-Control-Allow-Credentials: true Cache-Control: max-age=43200 Pragma: no-cache Expires: -1 X-Content-Type-Options: nosniff Etag: W/"124-yiKdLzqO5gfBrJFrcdJ8Yq0LGnU" Via: 1.1 vegur CF-Cache-Status: HIT Age: 1983 Accept-Ranges: bytes Server: cloudflare CF-RAY: 8d700bdd4a385b4f-VIE alt-svc: h3=":443"; ma=86400 server-timing: cfL4;desc="?proto=TCP&rtt=25362&sent=5&recv=6&lost=0&retrans=0&sent_bytes=3130&recv_bytes=510&delivery_rate=144240&cwnd=252&unsent_bytes=0&cid=748ae82f39ab1e32&ts=71&x=0"
Этот вывод содержит важную информацию для анализа ответов API и отладки запросов. В нём есть статус ответа (200 OK), тип содержимого (например, application/json), длина контента, а также заголовки кэширования, безопасности и ограничения скорости. Такие сведения помогают разработчикам лучше понять взаимодействие с сервером и выявить потенциальные проблемы.
Аутентификация обеспечивает доступ к частным или защищённым ресурсам. Сервис JSONPlaceholder не требует аутентификации, однако вы можете выполнить команду, демонстрирующую передачу данных при работе с защищёнными API. В нашем примере сервер вернёт список постов, а в реальном сценарии такой запрос открыл бы доступ к закрытому ресурсу:
curl -u username:password https://jsonplaceholder.typicode.com/posts
Редиректы полезны при работе с URL-адресами, которые могут перенаправлять на другие ресурсы. JSONPlaceholder не использует редиректы, поэтому команда ниже эмулирует этот процесс, позволяя Curl автоматически следовать по цепочке переадресаций сайтов. При реальном запросе вы получите конечный ресурс после различных перенаправлений:
curl -L https://jsonplaceholder.typicode.com/posts/1
Вы можете отправлять POST-запросы для передачи больших объёмов данных или заранее подготовленной информации. Создадим файл newpost.json и сразу отправим его содержимое на JSONPlaceholder.
Добавим кодировку UTF-8, чтобы избежать ошибок при отображении данных на русском языке:
chcp 65001
Создадим файл newpost.json:
echo {"title": "Загруженный пост", "body": "Содержимое поста", "userId": 1} > newpost.json curl -X POST -H "Content-Type: application/json" -d @newpost.json https://jsonplaceholder.typicode.com/posts
Получаем ответ от сервера, подтверждающий выполнение запроса:
C:\Users\user>curl -X POST -H "Content-Type: application/json" -d @newpost.json https://jsonplaceholder.typicode.com/posts { "title": "Загруженный пост", "body": "Содержимое поста", "userId": 1, "id": 101 }
Вы познакомились с возможностями Curl, и, если считаете, что этот инструмент может пригодиться в работе, рекомендуем следующие ресурсы:
- Everything curl — бесплатная онлайн-версия книги от создателя Curl, в которой он подробно рассказывает об устройстве технологии.
- Официальная документация с описанием всех опций и команд Curl.
- Блог Даниэля Стенберга, где он часто пишет о Curl и смежных технологиях.
- GitHub-репозиторий Curl — позволяет отслеживать разработку проекта, сообщать о проблемах и вносить свой вклад в развитие Curl.
- Curl Сookbook — сборник практических примеров использования Curl для решения различных задач.
Научитесь: Старт в DevOps: системное администрирование для начинающих
Узнать больше
Время на прочтение9 мин
Количество просмотров225K
Curl (client URL) — это инструмент командной строки на основе библиотеки libcurl для передачи данных с сервера и на сервер при помощи различных протоколов, в том числе HTTP, HTTPS, FTP, FTPS, IMAP, IMAPS, POP3, POP3S, SMTP и SMTPS. Он очень популярен в сфере автоматизации и скриптов благодаря широкому диапазону функций и поддерживаемых протоколов. В этой статье мы расскажем, как использовать curl в Windows на различных примерах.
▍ Установка в Windows
Во всех современных версиях Windows, начиная с Windows 10 (версия 1803) и Server 2019, исполняемый файл curl поставляется в комплекте, поэтому ручная установка не требуется. Чтобы определить местоположение curl и его версию в системе, можно использовать следующие команды:
where curl
curl --version
Определение местоположения и версии curl в Windows
Команда curl —version также выводит список протоколов и функций, поддерживаемых текущей версией curl. Как видно из показанного выше скриншота, к использованию встроенной утилиты curl всё готово. Если вместо этого отображается сообщение об ошибке, curl может быть недоступен потому, что вы используете более раннюю версию Windows (например, Windows 8.1 или Server 2016). В таком случае вам потребуется установить curl в Windows вручную.
▍ Синтаксис curl
Команда curl использует следующий синтаксис:
curl [options...] [url]
Инструмент поддерживает различные опции, которые мы рассмотрим ниже. Как и в любом инструменте командной строки, вы можете использовать для получения справки команду curl —help.
Получение справки при помощи команды curl
Для получения подробной справки можно использовать команду curl —help all. Справка разделена на категории, поэтому при помощи curl —help category можно просмотреть все темы.
Ознакомившись с синтаксисом curl, давайте рассмотрим различные способы применения этого инструмента на примерах.
▍ HTTP-запрос GET
При использовании curl с URL и без указания опций запрос по умолчанию использует метод GET протокола HTTP. Попробуйте выполнить такую команду:
curl https://4sysops.com
Приведённая выше команда по сути эквивалентна curl —request GET 4sysops.com, отправляющей запрос GET к 4sysops.com по протоколу HTTPS. Чтобы указать версию протокола HTTP (например, http/2), используйте опцию —http2:
curl --http2 https://4sysops.com
В случае URL, начинающихся с HTTPS, curl сначала пытается установить соединение http/2 и автоматически откатывается к http/1.1, если это не удаётся. Также он поддерживает другие методы, например, HEAD, POST, PUT и DELETE. Для использования этих методов вместе с командой curl нужно указать опцию —request (или -X), за которой следует указание метода. Стоит заметить, что список доступных методов зависит от используемого протокола.
▍ Получение информации об удалённом файле
Если вы администратор, то иногда вам могут быть интересны только заголовки HTTP. Их можно получить при помощи опции —head (или -I). Иногда URL может перенаправлять пользователя в другую точку. В таком случае опция —location (или -L) позволяет curl выполнять перенаправления. Также можно использовать —insecure (или -k), чтобы разрешить незащищённые подключения и избежать ошибок с сертификатом TLS в случае, если целевой URL использует самоподписанный сертификат. Пользуйтесь этой опцией только при абсолютной необходимости. Все эти три опции можно скомбинировать в одну краткую запись, как показано в следующей команде:
curl -kIL 4sysops.com
Опции просмотра заголовков запросов, включения незащищённого соединения и использования перенаправлений
Как можно заметить, такая краткая запись особенно полезна для комбинирования нескольких опций. Приведённая выше команда по сути эквивалентна команде curl —insecure —head —location 4sysops.com.
Опция —head (или -I) также даёт основную информацию об удалённом файле без его скачивания. Как показано на скриншоте ниже, при использовании curl с URL удалённого файла он отображает различные заголовки, дающие информацию об удалённом файле.
curl -IL https://curl.se/windows/dl-7.85.0_5/curl-7.85.0_5-win64-mingw.zip
Использование curl для просмотра основной информации удалённых файлов
Заголовок Content-Length обозначает размер файла (в байтах), Content-Type сообщает о типе медиафайла (например, image/png, text/html), Server обозначает тип серверного приложения (Apache, Gunicorn и так далее), Last-Modified показывает дату последнего изменения файла на сервере, а заголовок Accept-Ranges обозначает поддержку частичных запросов для скачивания от клиента, что по сути определяет возможность продолжения прерванной загрузки.
▍ Скачивание файла
Для скачивания файла и сохранения с тем же именем, что и на сервере, можно использовать curl с опцией —remote-name (или -O). Показанная ниже команда скачивает последнюю версию curl для Windows с официального сайта:
curl -OL https://curl.se/windows/latest.cgi?p=win64-mingw.zip
Скачивание файла с именем по умолчанию и индикатором прогресса
При необходимости для нахождения ресурса добавляется опция -L, разрешающая перенаправления. Если нужно сохранить файл с новым именем, используйте опцию —output (или -o). Кроме того, при использовании команды curl в скрипте может понадобиться отключить индикатор прогресса, что можно сделать при помощи опции —silent (или -s). Эти две опции можно скомбинировать:
curl -sLo curl.zip https://curl.se/windows/latest.cgi?p=win64-mingw.zip
Скачивание файла без индикатора и сохранение под произвольным именем
▍ Продолжение прерванного скачивания
Наличие Accept-Ranges: bytes в заголовке ответа в буквальном смысле обозначает, что сервер поддерживает скачивания с возможностью продолжения. Чтобы продолжить прерванное скачивание, можно использовать опцию —continue-at (или -C), получающую смещение (в байтах). Обычно указывать смещение непросто, поэтому curl предоставляет простой способ продолжения прерванной загрузки:
curl -OLC - https://releases.ubuntu.com/22.04/ubuntu-22.04.1-desktop-amd64.iso
Продолжение прерванного скачивания
Как видно из скриншота, я скачивал iso-файл Ubuntu, но скачивание было прервано. Затем я снова запустил команду curl с опцией -C, и передача продолжилась с того диапазона байтов, на котором была прервана. Знак минус (—) рядом с -C позволяет curl автоматически определить, как и где продолжить прерванное скачивание.
▍ Аутентификация с Curl
Также Curl поддерживает аутентификацию, что позволяет скачать защищённый файл, предоставив учётные данные при помощи опции —user (or -u), принимающей имя пользователя и пароль в формате username:password. Если не вводить пароль, curl попросит ввести его в режиме no-echo.
curl -u surender -OL https://techtutsonline.com/secretFiles/sample.zip
Скачивание файла с аутентификацией по имени пользователя и паролю
Если вы используете Basic authentication, то необходимо передать имя пользователя и пароль, а значит, воспользоваться защищённым протоколом наподобие HTTPS (вместо HTTP) или FTPS (вместо FTP). Если по каким-то причинам приходится использовать протокол без шифрования, то убедитесь, что вы используете способ аутентификации, не передающий учётные данные в виде простого текста (например, аутентификацию Digest, NTLM или Negotiate).
Также curl поддерживает использование файлов конфигурации .curlrc, _curlrc и .netrc, позволяющих задавать различные опции curl в файле, а затем добавлять файл в команду при помощи опции curl —config (или curl -K), что особенно полезно при написании скриптов.
▍ Выгрузка файла
Опция —upload-file (или -T) позволяет выгружать локальный файл на удалённый сервер. Показанная ниже команда выгружает файл из локальной системы на удалённый веб-сервер по протоколу FTPS:
curl -kT C:\Users\Surender\Downloads\sample1.zip -u testlab\surender ftps://192.168.0.80/awesomewebsite.com/files/
Выгрузка файла на удалённый сервер
Опция -k добавляется для устранения проблем с сертификатами на случай, если веб-сервер использует самоподписанный сертификат. Наклонная черта в конце URL сообщает curl, что конечная точка является папкой. Можно указать несколько имён файлов, например «{sample1.zip,sample2.zip}». Ниже показано, как с помощью одной команды curl можно выгрузить на сервер несколько файлов:
curl -kT sample[1-5].zip -u testlab\surender ftps://192.168.0.80/awesomewebsite.com/files/
Выгрузка нескольких файлов на сервер
▍ Последовательность команд
Как говорилось ранее, curl поддерживает различные методы в зависимости от используемого протокола. Дополнительные команды можно отправлять при помощи —quote (или -Q) для выполнения операции до или после обычной операции curl. Например, можно скачать файл с удалённого сервера по протоколу FTPS и удалить файл с сервера после успешного скачивания. Для этого нужно выполнить следующую команду:
curl -u testlab\surender -kO "ftps://192.168.0.80/awesomewebsite.com/files/sample1.zip" -Q "-DELE sample1.zip"
Удаление файла после успешного скачивания
В показанном выше примере я скачал файл sample1.zip с FTPS-сервера при помощи опции -O. После опции -Q я добавил минус (-) перед командой DELE, что заставляет curl отправить команду DELE sample1.zip сразу после успешного скачивания файла. Аналогично, если вы хотите отправить команду на сервер до выполнения операции curl, используйте плюс (+) вместо минуса.
▍ Изменение user-agent
Информация user-agent сообщает серверу тип клиента, отправляющего запрос. При отправке запроса curl на сервер по умолчанию используется user-agent curl/<version>. Если сервер настроен так, чтобы блокировать запросы curl, можно задать собственный user-agent при помощи опции —user-agent (или -A). Показанная ниже команда отправляет стандартный user-agent Google Chrome:
curl -kIA "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0" https://awesomewebsite.com/files/secretFile.zip
Использование собственного user-agent с командой curl, чтобы избежать блокировки сервером
На показанном выше скриншоте видно, что обычный запрос curl был отклонён веб-сервером (с ответом 403 Forbidden), но при передаче другого user-agent запрос выполняется успешно, возвращая ответ 200 OK.
▍ Отправка куки
По умолчанию запрос curl не отправляет и не сохраняет куки. Для записи куки можно использовать опцию —cookie-jar (или -c), а отправить куки можно опцией —cookie (or -b):
curl -c /path/cookie_file https://awesomewebsite.com/
curl -b /path/cookie_file https://awesomewebsite.com/
Первая команда записывает файл куки, а вторая отправляет куки с запросом curl. Также можно отправить куки в формате ‘name = value’:
curl -b 'session=abcxyz' -b 'loggedin=true' http://echo.hoppscotch.io
Отправка нескольких куки командой curl
Я воспользовался веб-сайтом echo.hoppscotch.io для демонстрации заголовков HTTP-запросов, которые обычно невидимы клиентам, отправляющим запрос. Если вы не хотите пользоваться этим веб-сайтом, то можете применить опцию –verbose (или -v) для отображения запроса в сыром виде (который отображает и заголовки запросов).
▍ Использование прокси-сервера
Если вы пользуетесь прокси-сервером для подключения к интернету, в curl можно указать прокси опцией —proxy (или -x). Если прокси-сервер требует аутентификации, то добавьте —proxy-user (или -U):
curl -x 192.168.0.250:8088 -U username:password https://awesomewebsite.com/
Прокси-сервер указывается в формате server:port, а пользователь прокси — в формате username:password. Можно не вводить пароль пользователя прокси, тогда curl попросит ввести его в режиме no-echo.
Использование прокси-сервера и аутентификации
▍ Дополнительные заголовки запросов
Иногда вместе с запросом к серверу необходимо отправить дополнительную информацию. В curl это можно сделать при помощи —header (или -H), как показано в следующей команде:
curl -vkIH "x-client-os: Windows 11 Enterprise (x64)" https://awesomewebsite.com
Указание дополнительных заголовков для запроса curl
Можно отправлять любую информацию, недоступную через стандартные заголовки HTTP-запросов. В этом примере я отправил название своей операционной системы. Также я добавил опцию -v для включения verbose-вывода, отображающего дополнительный заголовок, отправляемый вместе с каждым моим запросом curl.
▍ Отправка электронного письма
Так как curl поддерживает протокол SMTP, его можно использовать для отправки электронного письма. Показанная ниже команда позволяет отправить электронное письмо при помощи curl:
curl --insecure --ssl-reqd smtps://mail.yourdomain.com –-mail-from sender@yourdomain.com –-mail-rcpt receiver@company.com --user sender@yourdomain.com --upload-file email_msg.txt
Отправка электронного письма командой curl
Давайте вкратце перечислим использованные здесь опции:
- Опция —insecure (или -k) используется, чтобы избежать ошибки сертификата SSL. Мы уже применяли её ранее.
- Опция —ssl-reql используется для апгрейда соединения передачи простого текста до зашифрованного соединения, если оно поддерживается SMTP-сервером. Если вы уверены, что ваш SMTP-сервер поддерживает SSL, то можно использовать непосредственно имя сервера smtps (например, smtps://smtp.yourdomain.com), как показано на скриншоте.
- Опция —mail-from используется для указания адреса электронной почты отправителя.
- Опция mail-rcpt указывает адрес электронной почты получателя.
- Опция —user (или -u) отправляет имя пользователя для аутентификации, оно должно совпадать с адресом mail-from, потому что в противном случае письмо может быть отклонено или помечено как спам.
- Опция —upload-file (или -T) используется для указания файла, в котором находится отправляемое письмо.
На скриншоте ниже показано письмо, полученное мной во входящие:
Просмотр письма, отправленного с помощью curl
Это всего лишь несколько примеров использования curl — на самом деле их гораздо больше. Я настоятельно рекомендую проверить справку по curl и поэкспериментировать с ней.
А вы используете curl? И если да, то для чего?
Telegram-канал с полезностями и уютный чат
cURL (curl) is an open source command-line tool used for transferring data over a network. POST is an HTTP request method which is used to send data to the server. (Read more on POST requests here.)
The format of a POST request with curl is: curl -X POST [options] [URL].
An example POST request to submit a todo list task to a REST API might look like:
curl -H 'Content-Type: application/json' \
-d '{ "title":"foo","body":"bar", "id": 1}' \
-X POST \
https://example.com/posts
Three options provided here are:
- -X was used to provide the HTTP method we use to send the request. In this case, the method is POST
- -d was used to provide the associated data in the body of the HTTP request
- -H was used to specify headers for the request
Each of these options also have associated aliases. For example, for -X you can instead provide —request, and for -H you can provide —headers.
These are just some of the possible options, but there are many others, enumerated below.
Common POST Request Operations
Sending Form Data
There are two common ways to send form data with POST requests, each with different content-types, demonstrated below:
# multipart/form-data
## Text Field
curl -H "Content-type: multipart/form-data" \
-F title=foo \
-F body=bar \
-F id="1" \
-X POST \
https://example.com/posts
## Image Upload
curl -H "Content-type: multipart/form-data" \
-F [email protected] \
https://example.com/avatar.cgi
# application/x-www-form-urlencoded
curl -H "Content-type: application/x-www-form-urlencoded" \
-d "title=foo" \
-d "body=bar" \
-d "id=1" \
-X POST \
https://example.com/posts
As we can see from the image, to use multipart/form-data content-type, we send data with the -F (or —form option). To use application/x-www-form-urlencoded content-type, we use the -d (or —data) option.
Generally speaking, multipart/form-data is more often used to send binary data like images, while application/x-www-form-urlencoded is used to send text data.
By default, HTML forms will send data using the content-type of application/x-www-form-urlencoded when submitted.
Sending Image Data
To send image data in a POST request, include the image in the form data by prefixing the filename with an @ symbol as follows:
curl -F [email protected] \
https://example.com/avatar.cgi
The @ symbol forces the content part of the form to be a file, which is then uploaded to the server.
Alternatively, we could base64 encode the image and send it as a field in a form field or JSON body field of your request, but this is far less ergonomic:
curl -H 'Content-Type: application/json' \
-d '{"image" : "'"$(base64 ~/avatar.jpg)"'"}' \
-X POST \
https://example.com/avatar.cgi
Common Gotchas
- Argument names are case sensitive. For example, -F corresponds to the argument for form data, while -f is a flag indicating whether we want to fail fast with no output
- When passing content of type application/json, be sure to wrap the JSON body in single quotes — e.g. -d «{ «title»:»foo» }» would be invalid
- You can only use breaklines if you include \ a backslash character. There can be no trailing spaces after the backslash
cURL POST Request Arguments
Arguments available for the options field of the curl POST format (curl -X POST [options] [URL]) are enumerated below:
Short Option | Long Option | Argument(s) | Purpose |
---|---|---|---|
-X | —requests | <method> (use «POST» or POST requests) | Specify the request method to use when communicating with an HTTP server |
-b | —cookie | <data | filename> |
-c | —cookie-jar | <filename> | |
-d | —data | <data> | Send data in POST request |
-f | —fail | Fail fast with no output on server errors | |
-F | —form | <name=content> | Form data for content-type application/x-www-form-urlencoded |
-H | —header | header/@file | Header to include in the request |
-i | —include | Include HTTP headers in the output | |
-l | —head | Fetch the headers only | |
-k | —insecure | Skip verification that connection is secure | |
-L | —location | If a redirect is received (3XX), force curl to redo the request on the new address | |
-o | —output | <file> | Write output to file instead of stdout |
-O | —remote-name | Write output to a local file named like the remote file | |
-s | —silent | Do not show progress meter or error messages | |
-v | —verbose | Make curls verbose during operation. Useful for debugging | |
-w | —write-out | <format> | Make curl display information on stdout after a completed transfer. See possible variables to include in output here |
Read more on the official curl docs.
In PowerShell, you can use the `curl` command (which is an alias for `Invoke-WebRequest`) to send a POST request to a specified URL with data, as shown in the following example:
curl -Uri "https://example.com/api" -Method Post -Body @{ param1="value1"; param2="value2" } -ContentType "application/x-www-form-urlencoded"
Understanding cURL in the Context of PowerShell
What is cURL?
cURL is a command-line tool and library for transferring data with URLs. It supports numerous protocols, allowing users to interact with web servers by sending and receiving data over the internet. In particular, cURL is frequently used for making HTTP requests, which are central to web applications and APIs.
Why Use PowerShell for cURL Operations?
PowerShell provides several advantages when working with cURL operations:
- Integration: PowerShell is versatile and can easily integrate with other scripts and applications.
- Object-Oriented: Unlike traditional cURL commands that return raw data, PowerShell’s `Invoke-RestMethod` and `Invoke-WebRequest` return .NET objects, allowing for more straightforward manipulation and access to data.
- Ease of Use: PowerShell syntax is often considered more accessible for scripts and administrative tasks in Windows environments.
Mastering PowerShell Curl: A Simple Guide
Setting Up Your PowerShell Environment
Prerequisites
Before diving into using PowerShell for cURL operations, ensure you’re using a compatible version of PowerShell. PowerShell 3.0 or later is recommended for the best support for web requests. You typically don’t need an additional cURL installation on Windows systems; PowerShell’s built-in commands are sufficient for most use cases.
Mastering PowerShell Post: A Quick Guide to Commands
Making a POST Request with PowerShell
Introduction to POST Requests
In HTTP, a POST request is used to send data to a server. This data usually includes form data or JSON, which the server processes and responds to accordingly. Unlike GET requests, which retrieve data from a server, POST requests are commonly used for creating or updating resources.
Using Invoke-RestMethod for POST
Syntax Overview
The `Invoke-RestMethod` cmdlet is a PowerShell command specifically designed for working with REST APIs. Here’s its basic syntax:
Invoke-RestMethod -Uri <Uri> -Method <Method> -Body <Body> -Headers <Headers>
Example: Basic POST Request
To make a straightforward POST request using `Invoke-RestMethod`, you can use the following code:
$Uri = "https://example.com/api"
$Body = @{ key1 = "value1"; key2 = "value2" }
Invoke-RestMethod -Uri $Uri -Method Post -Body $Body
In this example:
- `$Uri` specifies the API endpoint.
- `$Body` holds the data sent to the server. It is defined as a hashtable, which will be converted to form URL-encoded format.
- The response will be outputted directly into the console.
Using Invoke-WebRequest for POST
Syntax Overview
The `Invoke-WebRequest` cmdlet differs slightly from `Invoke-RestMethod`, mainly returning raw response data rather than deserialized objects. Use it when you need detailed response information, such as headers or status codes.
Example: Basic POST Request
Here’s how to perform a POST request with `Invoke-WebRequest`:
$Uri = "https://example.com/api"
$Body = @{ key1 = "value1"; key2 = "value2" }
Invoke-WebRequest -Uri $Uri -Method Post -Body $Body
This command works similarly to the previous example, but it is especially useful when you need additional details about the HTTP response.
Mastering PowerShell PostgreSQL: A Quick Guide
Handling JSON Data
Sending JSON Data in a POST Request
Many APIs expect data in JSON format rather than URL-encoded strings. PowerShell makes it easy to convert data structures to JSON.
Creating and Converting Data to JSON
To create JSON, use the `ConvertTo-Json` cmdlet:
$Body = @{ key1 = "value1"; key2 = "value2" } | ConvertTo-Json
Making a POST request with JSON
Once you have your JSON, making a POST request is straightforward:
$Uri = "https://example.com/api"
Invoke-RestMethod -Uri $Uri -Method Post -Body $Body -ContentType "application/json"
Setting the `ContentType` to `»application/json»` informs the server of the format being sent, which is crucial for proper data handling.
PowerShell Curl Equivalent: A Quick Guide
Adding Headers to Your Requests
Custom Headers
In many cases, APIs require headers for authentication, such as an API key or bearer token, or to define the accepted response format.
Example: Adding Headers
To add headers to your POST request, use the `-Headers` parameter:
$Headers = @{ Authorization = "Bearer token"; "Accept" = "application/json" }
Invoke-RestMethod -Uri $Uri -Method Post -Body $Body -Headers $Headers
By customizing headers in this way, you can tailor your requests to meet specific API requirements.
Mastering PowerShell Curl -K for Secure Requests
Error Handling
Understanding HTTP Status Codes
When making API calls, it’s essential to understand the response status codes. Common codes include:
- 200 OK: The request succeeded.
- 400 Bad Request: There was an error in the request format.
- 401 Unauthorized: Authentication failed or the user doesn’t have the necessary permissions.
- 500 Internal Server Error: A generic error occurred on the server side.
Using Try-Catch for Error Management
Using PowerShell’s `try-catch` block is an effective way to catch errors during requests:
try {
$response = Invoke-RestMethod -Uri $Uri -Method Post -Body $Body -Headers $Headers
Write-Output $response
} catch {
Write-Error "Error occurred: $_"
}
This block will handle any exceptions thrown by the command, allowing for more resilient scripts.
Mastering PowerShell Curl Headers: A Quick Guide
Testing and Debugging Your POST Requests
Using the PowerShell ISE or VS Code
Utilizing environments like PowerShell ISE or Visual Studio Code can simplify debugging with features like syntax highlighting and command suggestions.
How to Debug Your Requests
When testing your requests, inspect the returned variable. You can log the response or check properties directly, using commands like:
$response.StatusCode
$response.Content
These insights can help identify issues with your requests and the server’s responses.
Mastering PowerShell Substring: A Quick Guide
Best Practices for Using PowerShell cURL
Security Considerations
When dealing with sensitive information such as API keys, always prioritize security. Store such data securely, avoiding hardcoding them in scripts. Using natural PowerShell features like `Get-Credential` can help manage these connections securely.
Code Reusability
To unify your approach, create functions for common API interactions. Here’s a sample function for reusable POST requests:
function Invoke-MyPost {
param (
[string]$Uri,
[hashtable]$Body,
[hashtable]$Headers = @{}
)
$BodyJson = $Body | ConvertTo-Json
Invoke-RestMethod -Uri $Uri -Method Post -Body $BodyJson -Headers $Headers -ContentType "application/json"
}
This function simplifies making requests across multiple scripts or sessions, enhancing maintainability and reducing redundancy.
PowerShell List: Your Quick Guide to Effective Usage
Conclusion
In this guide, we’ve explored how to handle `PowerShell cURL POST` operations using PowerShell’s native cmdlets. By mastering the nuances of making POST requests, working with JSON, handling headers, and managing errors, you can efficiently interact with web APIs and automate various tasks.
For further learning, don’t hesitate to explore the extensive resources available in the PowerShell community. Practice is key to perfecting these skills and enhancing your productivity with PowerShell.