From 765e3576d0fe2202417640b79ff6a7ba4de1bf63 Mon Sep 17 00:00:00 2001
From: "Kayla Reopelle (she/her)"
 <87386821+kaylareopelle@users.noreply.github.com>
Date: Tue, 15 Nov 2022 09:27:16 -0800
Subject: [PATCH] Add instructions for user API key

PR https://github.com/newrelic/newrelic-ruby-agent/pull/1461 added support for deployment recording using a customer's user API key. This update was missing from the document.
---
 .../ruby-agent/features/record-deployments-ruby-agent.mdx | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/content/docs/apm/agents/ruby-agent/features/record-deployments-ruby-agent.mdx b/src/content/docs/apm/agents/ruby-agent/features/record-deployments-ruby-agent.mdx
index 21e370a5212c..68a1487d722a 100644
--- a/src/content/docs/apm/agents/ruby-agent/features/record-deployments-ruby-agent.mdx
+++ b/src/content/docs/apm/agents/ruby-agent/features/record-deployments-ruby-agent.mdx
@@ -24,6 +24,12 @@ To assign an application name:
 
 This will assign instances in the given environment the label given by `app_name` when browsing your data in the New Relic user interface. The deployment upload script will use that label to associate an app with the deployment.
 
+## Add your user API key (Optional) [#Api-Key]
+
+You can use the New Relic REST API v2 to record deployments by providing your user API key to the agent configuration using `api_key`. 
+
+When this configuration option is present, the `newrelic deployments` command will automatically use the New Relic REST API v2 deployment endpoint.
+
 ## Record with the command line [#Manual]
 
 If you installed the Ruby agent as a gem, you can record deployments directly by using the `newrelic` executable:
@@ -44,6 +50,8 @@ You can use several optional values with `newrelic`. The `description` is short
 deployments [OPTIONS] [description]
 OPTIONS:
    -a, --appname=name           Set the application name.
+   -i, --appid=ID               Set the application ID
+                                If not provided, will connect to the New Relic collector to get it
                                 Default is app_name setting in newrelic.yml
    -e, --environment=name       Override the (RAILS|RUBY)_ENV setting
    -u, --user=USER              Specify the user deploying.