Patch insight group - LaunchDarkly Documentation

PATCH

api

engineering-insights

insights

groups

{insightGroupKey}

Patch insight group

curl --request PATCH \
  --url https://app.launchdarkly.com/api/v2/engineering-insights/insights/groups/{insightGroupKey} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "op": "replace",
    "path": "/name",
    "value": "Prod group"
  }
]
'

import requests

url = "https://app.launchdarkly.com/api/v2/engineering-insights/insights/groups/{insightGroupKey}"

payload = [
    {
        "op": "replace",
        "path": "/name",
        "value": "Prod group"
    }
]
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify([{op: 'replace', path: '/name', value: 'Prod group'}])
};

fetch('https://app.launchdarkly.com/api/v2/engineering-insights/insights/groups/{insightGroupKey}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.launchdarkly.com/api/v2/engineering-insights/insights/groups/{insightGroupKey}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'op' => 'replace',
        'path' => '/name',
        'value' => 'Prod group'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.launchdarkly.com/api/v2/engineering-insights/insights/groups/{insightGroupKey}"

	payload := strings.NewReader("[\n  {\n    \"op\": \"replace\",\n    \"path\": \"/name\",\n    \"value\": \"Prod group\"\n  }\n]")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://app.launchdarkly.com/api/v2/engineering-insights/insights/groups/{insightGroupKey}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"op\": \"replace\",\n    \"path\": \"/name\",\n    \"value\": \"Prod group\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/engineering-insights/insights/groups/{insightGroupKey}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"op\": \"replace\",\n    \"path\": \"/name\",\n    \"value\": \"Prod group\"\n  }\n]"

response = http.request(request)
puts response.read_body

{
  "key": "default-production-all-apps",
  "name": "Production - All Apps",
  "projectKey": "default",
  "environmentKey": "production",
  "createdAt": "1706701522000",
  "environment": {
    "_links": {
      "self": {
        "href": "/api/v2/projects/my-project/environments/my-environment",
        "type": "application/json"
      }
    },
    "_id": "57be1db38b75bf0772d11384",
    "key": "environment-key-123abc",
    "name": "My Environment",
    "apiKey": "sdk-xxx",
    "mobileKey": "mob-xxx",
    "color": "F5A623",
    "defaultTtl": 5,
    "secureMode": true,
    "defaultTrackEvents": false,
    "requireComments": true,
    "confirmChanges": true,
    "tags": [
      "ops"
    ],
    "critical": true,
    "_access": {
      "denied": [
        {
          "action": "<string>",
          "reason": {
            "effect": "allow",
            "resources": [
              "proj/*:env/*;qa_*:/flag/*"
            ],
            "notResources": [
              "<string>"
            ],
            "actions": [
              "*"
            ],
            "notActions": [
              "<string>"
            ],
            "role_name": "<string>"
          }
        }
      ],
      "allowed": [
        {
          "action": "<string>",
          "reason": {
            "effect": "allow",
            "resources": [
              "proj/*:env/*;qa_*:/flag/*"
            ],
            "notResources": [
              "<string>"
            ],
            "actions": [
              "*"
            ],
            "notActions": [
              "<string>"
            ],
            "role_name": "<string>"
          }
        }
      ]
    },
    "approvalSettings": {
      "required": true,
      "bypassApprovalsForPendingChanges": false,
      "minNumApprovals": 1,
      "canReviewOwnRequest": false,
      "canApplyDeclinedChanges": true,
      "serviceKind": "launchdarkly",
      "serviceConfig": {},
      "requiredApprovalTags": [
        "require-approval"
      ],
      "autoApplyApprovedChanges": true,
      "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"
    },
    "resourceApprovalSettings": {}
  },
  "scores": {
    "overall": {
      "score": 100,
      "indicator": "excellent",
      "indicatorRange": {
        "min": 0,
        "max": 100
      },
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "diffVsLastPeriod": 123,
      "lastPeriod": "<unknown>"
    },
    "deploymentFrequency": {
      "score": 100,
      "indicator": "excellent",
      "indicatorRange": {
        "min": 0,
        "max": 100
      },
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "diffVsLastPeriod": 123,
      "lastPeriod": "<unknown>"
    },
    "deploymentFailureRate": {
      "score": 100,
      "indicator": "excellent",
      "indicatorRange": {
        "min": 0,
        "max": 100
      },
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "diffVsLastPeriod": 123,
      "lastPeriod": "<unknown>"
    },
    "leadTime": {
      "score": 100,
      "indicator": "excellent",
      "indicatorRange": {
        "min": 0,
        "max": 100
      },
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "diffVsLastPeriod": 123,
      "lastPeriod": "<unknown>"
    },
    "impactSize": {
      "score": 100,
      "indicator": "excellent",
      "indicatorRange": {
        "min": 0,
        "max": 100
      },
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "diffVsLastPeriod": 123,
      "lastPeriod": "<unknown>"
    },
    "experimentationCoverage": {
      "score": 100,
      "indicator": "excellent",
      "indicatorRange": {
        "min": 0,
        "max": 100
      },
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "diffVsLastPeriod": 123,
      "lastPeriod": "<unknown>"
    },
    "flagHealth": {
      "score": 100,
      "indicator": "excellent",
      "indicatorRange": {
        "min": 0,
        "max": 100
      },
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "diffVsLastPeriod": 123,
      "lastPeriod": "<unknown>"
    },
    "velocity": {
      "score": 100,
      "indicator": "excellent",
      "indicatorRange": {
        "min": 0,
        "max": 100
      },
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "diffVsLastPeriod": 123,
      "lastPeriod": "<unknown>"
    },
    "risk": {
      "score": 100,
      "indicator": "excellent",
      "indicatorRange": {
        "min": 0,
        "max": 100
      },
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "diffVsLastPeriod": 123,
      "lastPeriod": "<unknown>"
    },
    "efficiency": {
      "score": 100,
      "indicator": "excellent",
      "indicatorRange": {
        "min": 0,
        "max": 100
      },
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "diffVsLastPeriod": 123,
      "lastPeriod": "<unknown>"
    },
    "creationRatio": {
      "score": 100,
      "indicator": "excellent",
      "indicatorRange": {
        "min": 0,
        "max": 100
      },
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "diffVsLastPeriod": 123,
      "lastPeriod": "<unknown>"
    }
  },
  "scoreMetadata": {
    "period": {
      "startTime": "1706701522000",
      "endTime": "1706701522000"
    },
    "lastPeriod": {
      "startTime": "1706701522000",
      "endTime": "1706701522000"
    }
  },
  "applicationKeys": [
    "billing-service",
    "inventory-service"
  ]
}

{
  "code": "invalid_request",
  "message": "validation failed",
  "errors": [
    {
      "attribute": "projectKey",
      "reason": "must be present"
    }
  ]
}

{
  "code": "unauthorized",
  "message": "Invalid access token"
}

{
  "code": "forbidden",
  "message": "Forbidden. Access to the requested resource was denied."
}

{
  "code": "not_found",
  "message": "Invalid resource identifier"
}

{
  "code": "patch_failed",
  "message": "Unprocessable entity. Could not apply patch."
}

{
  "code": "rate_limited",
  "message": "You've exceeded the API rate limit. Try again later."
}

Authorizations

Authorization

string

header

required

Path Parameters

insightGroupKey

string<string>

required

The insight group key

Body

application/json

string

required

The type of operation to perform

Example:

"replace"

path

string

required

A JSON Pointer string specifying the part of the document to operate on

Example:

"/exampleField"

value

any

A JSON value used in "add", "replace", and "test" operations

Example:

"new example value"

Response

Insight group response

key

string

required

The insight group key

Example:

"default-production-all-apps"

name

string

required

The insight group name

Example:

"Production - All Apps"

projectKey

string

required

The project key

Example:

"default"

environmentKey

string

required

The environment key

Example:

"production"

createdAt

integer<int64>

required

The time the insight group was created

Example:

"1706701522000"

environment

object

Expanded details about the environment

Show child attributes

scores

object

The scores for the insight group

Show child attributes

scoreMetadata

object

Metadata about the insight scores, when expanded

Show child attributes

applicationKeys

string[]

The application keys

Example:

["billing-service", "inventory-service"]

⌘I

Patch insight group

curl --request PATCH \
  --url https://app.launchdarkly.com/api/v2/engineering-insights/insights/groups/{insightGroupKey} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "op": "replace",
    "path": "/name",
    "value": "Prod group"
  }
]
'

import requests

url = "https://app.launchdarkly.com/api/v2/engineering-insights/insights/groups/{insightGroupKey}"

payload = [
    {
        "op": "replace",
        "path": "/name",
        "value": "Prod group"
    }
]
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify([{op: 'replace', path: '/name', value: 'Prod group'}])
};

fetch('https://app.launchdarkly.com/api/v2/engineering-insights/insights/groups/{insightGroupKey}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.launchdarkly.com/api/v2/engineering-insights/insights/groups/{insightGroupKey}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'op' => 'replace',
        'path' => '/name',
        'value' => 'Prod group'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.launchdarkly.com/api/v2/engineering-insights/insights/groups/{insightGroupKey}"

	payload := strings.NewReader("[\n  {\n    \"op\": \"replace\",\n    \"path\": \"/name\",\n    \"value\": \"Prod group\"\n  }\n]")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://app.launchdarkly.com/api/v2/engineering-insights/insights/groups/{insightGroupKey}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"op\": \"replace\",\n    \"path\": \"/name\",\n    \"value\": \"Prod group\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/engineering-insights/insights/groups/{insightGroupKey}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"op\": \"replace\",\n    \"path\": \"/name\",\n    \"value\": \"Prod group\"\n  }\n]"

response = http.request(request)
puts response.read_body

{
  "key": "default-production-all-apps",
  "name": "Production - All Apps",
  "projectKey": "default",
  "environmentKey": "production",
  "createdAt": "1706701522000",
  "environment": {
    "_links": {
      "self": {
        "href": "/api/v2/projects/my-project/environments/my-environment",
        "type": "application/json"
      }
    },
    "_id": "57be1db38b75bf0772d11384",
    "key": "environment-key-123abc",
    "name": "My Environment",
    "apiKey": "sdk-xxx",
    "mobileKey": "mob-xxx",
    "color": "F5A623",
    "defaultTtl": 5,
    "secureMode": true,
    "defaultTrackEvents": false,
    "requireComments": true,
    "confirmChanges": true,
    "tags": [
      "ops"
    ],
    "critical": true,
    "_access": {
      "denied": [
        {
          "action": "<string>",
          "reason": {
            "effect": "allow",
            "resources": [
              "proj/*:env/*;qa_*:/flag/*"
            ],
            "notResources": [
              "<string>"
            ],
            "actions": [
              "*"
            ],
            "notActions": [
              "<string>"
            ],
            "role_name": "<string>"
          }
        }
      ],
      "allowed": [
        {
          "action": "<string>",
          "reason": {
            "effect": "allow",
            "resources": [
              "proj/*:env/*;qa_*:/flag/*"
            ],
            "notResources": [
              "<string>"
            ],
            "actions": [
              "*"
            ],
            "notActions": [
              "<string>"
            ],
            "role_name": "<string>"
          }
        }
      ]
    },
    "approvalSettings": {
      "required": true,
      "bypassApprovalsForPendingChanges": false,
      "minNumApprovals": 1,
      "canReviewOwnRequest": false,
      "canApplyDeclinedChanges": true,
      "serviceKind": "launchdarkly",
      "serviceConfig": {},
      "requiredApprovalTags": [
        "require-approval"
      ],
      "autoApplyApprovedChanges": true,
      "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"
    },
    "resourceApprovalSettings": {}
  },
  "scores": {
    "overall": {
      "score": 100,
      "indicator": "excellent",
      "indicatorRange": {
        "min": 0,
        "max": 100
      },
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "diffVsLastPeriod": 123,
      "lastPeriod": "<unknown>"
    },
    "deploymentFrequency": {
      "score": 100,
      "indicator": "excellent",
      "indicatorRange": {
        "min": 0,
        "max": 100
      },
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "diffVsLastPeriod": 123,
      "lastPeriod": "<unknown>"
    },
    "deploymentFailureRate": {
      "score": 100,
      "indicator": "excellent",
      "indicatorRange": {
        "min": 0,
        "max": 100
      },
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "diffVsLastPeriod": 123,
      "lastPeriod": "<unknown>"
    },
    "leadTime": {
      "score": 100,
      "indicator": "excellent",
      "indicatorRange": {
        "min": 0,
        "max": 100
      },
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "diffVsLastPeriod": 123,
      "lastPeriod": "<unknown>"
    },
    "impactSize": {
      "score": 100,
      "indicator": "excellent",
      "indicatorRange": {
        "min": 0,
        "max": 100
      },
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "diffVsLastPeriod": 123,
      "lastPeriod": "<unknown>"
    },
    "experimentationCoverage": {
      "score": 100,
      "indicator": "excellent",
      "indicatorRange": {
        "min": 0,
        "max": 100
      },
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "diffVsLastPeriod": 123,
      "lastPeriod": "<unknown>"
    },
    "flagHealth": {
      "score": 100,
      "indicator": "excellent",
      "indicatorRange": {
        "min": 0,
        "max": 100
      },
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "diffVsLastPeriod": 123,
      "lastPeriod": "<unknown>"
    },
    "velocity": {
      "score": 100,
      "indicator": "excellent",
      "indicatorRange": {
        "min": 0,
        "max": 100
      },
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "diffVsLastPeriod": 123,
      "lastPeriod": "<unknown>"
    },
    "risk": {
      "score": 100,
      "indicator": "excellent",
      "indicatorRange": {
        "min": 0,
        "max": 100
      },
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "diffVsLastPeriod": 123,
      "lastPeriod": "<unknown>"
    },
    "efficiency": {
      "score": 100,
      "indicator": "excellent",
      "indicatorRange": {
        "min": 0,
        "max": 100
      },
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "diffVsLastPeriod": 123,
      "lastPeriod": "<unknown>"
    },
    "creationRatio": {
      "score": 100,
      "indicator": "excellent",
      "indicatorRange": {
        "min": 0,
        "max": 100
      },
      "aggregateOf": [
        "deploymentFrequency",
        "leadTime"
      ],
      "diffVsLastPeriod": 123,
      "lastPeriod": "<unknown>"
    }
  },
  "scoreMetadata": {
    "period": {
      "startTime": "1706701522000",
      "endTime": "1706701522000"
    },
    "lastPeriod": {
      "startTime": "1706701522000",
      "endTime": "1706701522000"
    }
  },
  "applicationKeys": [
    "billing-service",
    "inventory-service"
  ]
}

{
  "code": "invalid_request",
  "message": "validation failed",
  "errors": [
    {
      "attribute": "projectKey",
      "reason": "must be present"
    }
  ]
}

{
  "code": "unauthorized",
  "message": "Invalid access token"
}

{
  "code": "forbidden",
  "message": "Forbidden. Access to the requested resource was denied."
}

{
  "code": "not_found",
  "message": "Invalid resource identifier"
}

{
  "code": "patch_failed",
  "message": "Unprocessable entity. Could not apply patch."
}

{
  "code": "rate_limited",
  "message": "You've exceeded the API rate limit. Try again later."
}